├── portal ├── __init__.py ├── wsgi.py ├── urls.py └── settings.py ├── repo ├── __init__.py ├── models.py ├── admin.py ├── tests.py ├── apps.py ├── forms.py ├── urls.py ├── templates │ └── repo │ │ ├── name.html │ │ ├── list_repo.html │ │ └── base.html └── views.py ├── user ├── __init__.py ├── models.py ├── admin.py ├── tests.py ├── apps.py ├── forms.py ├── urls.py ├── views.py └── templates │ └── user │ ├── name.html │ ├── base.html │ └── list_all.html ├── accounts ├── __init__.py ├── models.py ├── admin.py ├── tests.py ├── apps.py ├── urls.py └── views.py ├── algorithms ├── __init__.py ├── migrations │ └── __init__.py ├── models.py ├── tests.py ├── admin.py ├── views.py ├── apps.py ├── languages.txt ├── topics.txt ├── script.py ├── README.MD ├── repository_rating.py └── user_rating.py ├── CONTRIBUTING.md ├── templates ├── registration │ └── login.html ├── base.html └── signup.html ├── requirements.txt ├── manage.py ├── .gitignore ├── README.md └── LICENSE /portal/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /repo/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /user/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /user/models.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /accounts/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /algorithms/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /algorithms/migrations/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing Guidelines 2 | -------------------------------------------------------------------------------- /repo/models.py: -------------------------------------------------------------------------------- 1 | from django.db import models 2 | 3 | # Create your models here. 4 | -------------------------------------------------------------------------------- /accounts/models.py: -------------------------------------------------------------------------------- 1 | from django.db import models 2 | 3 | # Create your models here. 4 | -------------------------------------------------------------------------------- /repo/admin.py: -------------------------------------------------------------------------------- 1 | from django.contrib import admin 2 | 3 | # Register your models here. 4 | -------------------------------------------------------------------------------- /repo/tests.py: -------------------------------------------------------------------------------- 1 | from django.test import TestCase 2 | 3 | # Create your tests here. 4 | -------------------------------------------------------------------------------- /user/admin.py: -------------------------------------------------------------------------------- 1 | from django.contrib import admin 2 | 3 | # Register your models here. 4 | -------------------------------------------------------------------------------- /user/tests.py: -------------------------------------------------------------------------------- 1 | from django.test import TestCase 2 | 3 | # Create your tests here. 4 | -------------------------------------------------------------------------------- /accounts/admin.py: -------------------------------------------------------------------------------- 1 | from django.contrib import admin 2 | 3 | # Register your models here. 4 | -------------------------------------------------------------------------------- /accounts/tests.py: -------------------------------------------------------------------------------- 1 | from django.test import TestCase 2 | 3 | # Create your tests here. 4 | -------------------------------------------------------------------------------- /algorithms/models.py: -------------------------------------------------------------------------------- 1 | from django.db import models 2 | 3 | # Create your models here. 4 | -------------------------------------------------------------------------------- /algorithms/tests.py: -------------------------------------------------------------------------------- 1 | from django.test import TestCase 2 | 3 | # Create your tests here. 4 | -------------------------------------------------------------------------------- /algorithms/admin.py: -------------------------------------------------------------------------------- 1 | from django.contrib import admin 2 | 3 | # Register your models here. 4 | -------------------------------------------------------------------------------- /algorithms/views.py: -------------------------------------------------------------------------------- 1 | from django.shortcuts import render 2 | 3 | # Create your views here. 4 | -------------------------------------------------------------------------------- /repo/apps.py: -------------------------------------------------------------------------------- 1 | from django.apps import AppConfig 2 | 3 | 4 | class RepoConfig(AppConfig): 5 | name = 'repo' 6 | -------------------------------------------------------------------------------- /user/apps.py: -------------------------------------------------------------------------------- 1 | from django.apps import AppConfig 2 | 3 | 4 | class UserConfig(AppConfig): 5 | name = 'user' 6 | -------------------------------------------------------------------------------- /accounts/apps.py: -------------------------------------------------------------------------------- 1 | from django.apps import AppConfig 2 | 3 | 4 | class AccountsConfig(AppConfig): 5 | name = 'accounts' 6 | -------------------------------------------------------------------------------- /algorithms/apps.py: -------------------------------------------------------------------------------- 1 | from django.apps import AppConfig 2 | 3 | 4 | class AlgorithmsConfig(AppConfig): 5 | name = 'algorithms' 6 | -------------------------------------------------------------------------------- /user/forms.py: -------------------------------------------------------------------------------- 1 | from django import forms 2 | 3 | 4 | class NameForm(forms.Form): 5 | your_name = forms.CharField(label='your_name', max_length=100) 6 | -------------------------------------------------------------------------------- /accounts/urls.py: -------------------------------------------------------------------------------- 1 | from django.urls import path 2 | 3 | from . import views 4 | 5 | urlpatterns = [ 6 | path('signup/', views.SignUp.as_view(), name='signup'), 7 | ] -------------------------------------------------------------------------------- /templates/registration/login.html: -------------------------------------------------------------------------------- 1 |

Login

2 |
3 | {% csrf_token %} 4 | {{ form.as_p }} 5 | 6 |
-------------------------------------------------------------------------------- /repo/forms.py: -------------------------------------------------------------------------------- 1 | from django import forms 2 | 3 | class DetailForm(forms.Form): 4 | owner = forms.CharField(label='owner', max_length=100) 5 | repo = forms.CharField(label='repo', max_length=100) -------------------------------------------------------------------------------- /repo/urls.py: -------------------------------------------------------------------------------- 1 | from . import views 2 | from django.urls import include,path 3 | urlpatterns = [ 4 | path('', views.get_repo, name='get_repo'), 5 | path('/', views.get_repodetails, name='get_repodetails'), 6 | 7 | ] -------------------------------------------------------------------------------- /user/urls.py: -------------------------------------------------------------------------------- 1 | 2 | from . import views 3 | from django.urls import path, include 4 | 5 | urlpatterns = [ 6 | path('', views.get_username, name='get_username'), 7 | path('user//', views.list_all, name='list_all'), 8 | 9 | ] -------------------------------------------------------------------------------- /algorithms/languages.txt: -------------------------------------------------------------------------------- 1 | C++ 2 | Python 3 | Java 4 | JavaScript 5 | HTML 6 | CSS 7 | Shell 8 | Haskell 9 | Scala 10 | Ruby 11 | C# 12 | Erlang 13 | Go 14 | Lua 15 | PHP 16 | Swift 17 | Dart 18 | Jupyter Notebook 19 | CoffeeScript 20 | Batchfile 21 | -------------------------------------------------------------------------------- /repo/templates/repo/name.html: -------------------------------------------------------------------------------- 1 | {% extends 'user/base.html' %} 2 | 3 | {% block content %} 4 |
{% csrf_token %} 5 | {{ form.as_p }} 6 | 7 |
8 | {% endblock %} -------------------------------------------------------------------------------- /accounts/views.py: -------------------------------------------------------------------------------- 1 | from django.contrib.auth.forms import UserCreationForm 2 | from django.urls import reverse_lazy 3 | from django.views import generic 4 | 5 | 6 | class SignUp(generic.CreateView): 7 | form_class = UserCreationForm 8 | success_url = reverse_lazy('login') 9 | template_name = 'signup.html' -------------------------------------------------------------------------------- /templates/base.html: -------------------------------------------------------------------------------- 1 | 2 | {%load static%} 3 | 4 | GitLit 5 | 6 |
7 |
8 |
9 | {%block content%} 10 | {%endblock%} 11 |
12 |
13 |
14 | 15 | -------------------------------------------------------------------------------- /templates/signup.html: -------------------------------------------------------------------------------- 1 | {% extends 'base.html' %} 2 | 3 | {% block title %}Sign Up{% endblock %} 4 | 5 | {% block content %} 6 |

Sign up

7 |
8 | {% csrf_token %} 9 | {{ form.as_p }} 10 | 11 | SignUp with GitHub
12 |
13 | 14 | {% endblock %} -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | certifi==2019.6.16 2 | chardet==3.0.4 3 | defusedxml==0.6.0 4 | Django==2.2.4 5 | idna==2.8 6 | oauthlib==3.0.1 7 | PyJWT==1.7.1 8 | python-dateutil==2.8.0 9 | python3-openid==3.1.0 10 | pytz==2019.1 11 | requests==2.22.0 12 | requests-oauthlib==1.2.0 13 | six==1.12.0 14 | social-auth-app-django==3.1.0 15 | social-auth-core==3.2.0 16 | sqlparse==0.3.0 17 | urllib3==1.25.3 18 | -------------------------------------------------------------------------------- /portal/wsgi.py: -------------------------------------------------------------------------------- 1 | """ 2 | WSGI config for portal project. 3 | 4 | It exposes the WSGI callable as a module-level variable named ``application``. 5 | 6 | For more information on this file, see 7 | https://docs.djangoproject.com/en/2.2/howto/deployment/wsgi/ 8 | """ 9 | 10 | import os 11 | 12 | from django.core.wsgi import get_wsgi_application 13 | 14 | os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'portal.settings') 15 | 16 | application = get_wsgi_application() 17 | -------------------------------------------------------------------------------- /repo/templates/repo/list_repo.html: -------------------------------------------------------------------------------- 1 | {% extends 'repo/base.html' %} 2 | {%block content%} 3 |
4 |
5 |
    6 |
  1. basepoints: {{ repodetails.basePoints }}
    2. 7 |
  2. activityPoints:{{repodetails.activityPoints}}
    3. 8 |
  3. inclusivityPoints:{{repodetails.inclusivityPoints}}
    4. 9 |
  4. meritPoints:{{repodetails.meritPoints}}
    5. 10 |
  5. repoPoints: {{repodetails.repoPoints}}
    6. 11 |
12 | 13 |
14 |
15 | {%endblock%} 16 | -------------------------------------------------------------------------------- /user/views.py: -------------------------------------------------------------------------------- 1 | 2 | from algorithms.user_rating import UserMetrics 3 | from django.shortcuts import render, redirect 4 | from django.shortcuts import render 5 | 6 | from .forms import NameForm 7 | 8 | def list_all(request, your_name): 9 | usermetrics = UserMetrics(your_name, "") 10 | return render(request, 'user/list_all.html', {"usermetrics": usermetrics}) 11 | 12 | def get_username(request): 13 | form = NameForm(request.POST) 14 | username = request.POST.get('your_name') 15 | if request.method == 'POST': 16 | 17 | return redirect('list_all', username) 18 | 19 | else: 20 | form=NameForm() 21 | return render(request, 'user/name.html', {'form': form}) 22 | -------------------------------------------------------------------------------- /manage.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | """Django's command-line utility for administrative tasks.""" 3 | import os 4 | import sys 5 | 6 | 7 | def main(): 8 | os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'portal.settings') 9 | try: 10 | from django.core.management import execute_from_command_line 11 | except ImportError as exc: 12 | raise ImportError( 13 | "Couldn't import Django. Are you sure it's installed and " 14 | "available on your PYTHONPATH environment variable? Did you " 15 | "forget to activate a virtual environment?" 16 | ) from exc 17 | execute_from_command_line(sys.argv) 18 | 19 | 20 | if __name__ == '__main__': 21 | main() 22 | -------------------------------------------------------------------------------- /repo/views.py: -------------------------------------------------------------------------------- 1 | from django.shortcuts import render, redirect 2 | from algorithms.repository_rating import RepositoryMetrics 3 | from .forms import DetailForm 4 | # Create your views here. 5 | def get_repodetails(request, owner, reponame): 6 | repodetails = RepositoryMetrics(reponame, owner, '') 7 | 8 | return render(request, 'repo/list_repo.html', {'repodetails': repodetails}) 9 | 10 | def get_repo(request): 11 | form = DetailForm(request.POST) 12 | owner = request.POST.get('owner') 13 | reponame = request.POST.get('repo') 14 | if request.method == 'POST': 15 | 16 | return redirect('get_repodetails', owner, reponame) 17 | 18 | else: 19 | form=DetailForm() 20 | return render(request, 'repo/name.html', {'form': form}) -------------------------------------------------------------------------------- /user/templates/user/name.html: -------------------------------------------------------------------------------- 1 | {% extends 'repo/base.html' %} 2 | {% block content %} 3 | 14 | {% if user.is_authenticated %} 15 |
16 |
{% csrf_token %} 17 | {{ form.as_p }} 18 | 19 |
20 |
21 | {% else %} 22 |
23 |

Welcome to GitLit

24 |
GitLit is a social network exclusively for Open-Source developers. It works by connecting enthusiastic developers to the most interesting and relevant projects to them and forming new communities of like-minded and passionate developers.
25 |
26 | {% endif %} 27 | {% endblock %} -------------------------------------------------------------------------------- /portal/urls.py: -------------------------------------------------------------------------------- 1 | """portal URL Configuration 2 | 3 | The `urlpatterns` list routes URLs to views. For more information please see: 4 | https://docs.djangoproject.com/en/2.2/topics/http/urls/ 5 | Examples: 6 | Function views 7 | 1. Add an import: from my_app import views 8 | 2. Add a URL to urlpatterns: path('', views.home, name='home') 9 | Class-based views 10 | 1. Add an import: from other_app.views import Home 11 | 2. Add a URL to urlpatterns: path('', Home.as_view(), name='home') 12 | Including another URLconf 13 | 1. Import the include() function: from django.urls import include, path 14 | 2. Add a URL to urlpatterns: path('blog/', include('blog.urls')) 15 | """ 16 | from django.contrib import admin 17 | from django.urls import path, include 18 | 19 | urlpatterns = [ 20 | path('admin/', admin.site.urls), 21 | path('',include('user.urls')), 22 | path('repo/', include('repo.urls')), 23 | path('accounts/', include('accounts.urls')), 24 | path('accounts/', include('django.contrib.auth.urls')), 25 | path('oauth/',include('social_django.urls'), name='social'), 26 | ] 27 | -------------------------------------------------------------------------------- /repo/templates/repo/base.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | {%load static%} 7 | 8 | 17 |
18 | 31 |
32 |
33 |
34 |
35 | {%block content%} 36 | {%endblock%} 37 |
38 |
39 |
40 | -------------------------------------------------------------------------------- /user/templates/user/base.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | {%load static%} 7 | 8 | 17 |
18 | 31 |
32 |
33 |
34 |
35 | {%block content%} 36 | {%endblock%} 37 |
38 |
39 |
40 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | # Created by https://www.gitignore.io/api/django 3 | # Edit at https://www.gitignore.io/?templates=django 4 | 5 | ### Django ### 6 | *.log 7 | *.pot 8 | *.pyc 9 | __pycache__/ 10 | local_settings.py 11 | db.sqlite3 12 | media 13 | 14 | # If your build process includes running collectstatic, then you probably don't need or want to include staticfiles/ 15 | # in your Git repository. Update and uncomment the following line accordingly. 16 | # /staticfiles/ 17 | 18 | ### Django.Python Stack ### 19 | # Byte-compiled / optimized / DLL files 20 | *.py[cod] 21 | *$py.class 22 | 23 | # C extensions 24 | *.so 25 | 26 | # Distribution / packaging 27 | .Python 28 | build/ 29 | develop-eggs/ 30 | dist/ 31 | downloads/ 32 | eggs/ 33 | .eggs/ 34 | lib/ 35 | lib64/ 36 | parts/ 37 | sdist/ 38 | var/ 39 | wheels/ 40 | pip-wheel-metadata/ 41 | share/python-wheels/ 42 | *.egg-info/ 43 | .installed.cfg 44 | *.egg 45 | MANIFEST 46 | 47 | # PyInstaller 48 | # Usually these files are written by a python script from a template 49 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 50 | *.manifest 51 | *.spec 52 | 53 | # Installer logs 54 | pip-log.txt 55 | pip-delete-this-directory.txt 56 | 57 | # Unit test / coverage reports 58 | htmlcov/ 59 | .tox/ 60 | .nox/ 61 | .coverage 62 | .coverage.* 63 | .cache 64 | nosetests.xml 65 | coverage.xml 66 | *.cover 67 | .hypothesis/ 68 | .pytest_cache/ 69 | 70 | # Translations 71 | *.mo 72 | 73 | # Django stuff: 74 | 75 | # Flask stuff: 76 | instance/ 77 | .webassets-cache 78 | 79 | # Scrapy stuff: 80 | .scrapy 81 | 82 | # Sphinx documentation 83 | docs/_build/ 84 | 85 | # PyBuilder 86 | target/ 87 | 88 | # Jupyter Notebook 89 | .ipynb_checkpoints 90 | 91 | # IPython 92 | profile_default/ 93 | ipython_config.py 94 | 95 | # pyenv 96 | .python-version 97 | 98 | # pipenv 99 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 100 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 101 | # having no cross-platform support, pipenv may install dependencies that don’t work, or not 102 | # install all needed dependencies. 103 | #Pipfile.lock 104 | 105 | # celery beat schedule file 106 | celerybeat-schedule 107 | 108 | # SageMath parsed files 109 | *.sage.py 110 | 111 | # Environments 112 | .env 113 | .venv 114 | env/ 115 | venv/ 116 | ENV/ 117 | env.bak/ 118 | venv.bak/ 119 | 120 | # Spyder project settings 121 | .spyderproject 122 | .spyproject 123 | 124 | # Rope project settings 125 | .ropeproject 126 | 127 | # mkdocs documentation 128 | /site 129 | 130 | # mypy 131 | .mypy_cache/ 132 | .dmypy.json 133 | dmypy.json 134 | 135 | # Pyre type checker 136 | .pyre/ 137 | 138 | # End of https://www.gitignore.io/api/django 139 | -------------------------------------------------------------------------------- /user/templates/user/list_all.html: -------------------------------------------------------------------------------- 1 | {% extends 'user/base.html' %} 2 | {%block content%} 3 | 11 |
12 |
13 |
14 |
15 |

{{ usermetrics.fullName }}

16 |

Full Name

17 |
18 |
19 |

{{usermetrics.userPoints}}

20 |

User Points

21 |
22 |
23 |

{{ usermetrics.followersCount }}

24 |

Followers Count

25 |
26 |
27 |

{{ usermetrics.followingCount }}

28 |

Following Count

29 |
30 |
31 |
32 |
33 |
34 |

{{ usermetrics.basePoints }}

35 |

Base Points

36 |
37 |
38 |
39 |
40 |

{{ usermetrics.creationPoints }}

41 |

Creation Points

42 |
43 |
44 |
45 |
46 |

{{ usermetrics.activityPoints }}

47 |

Activity Points

48 |
49 |
50 |
51 |
52 |

{{ usermetrics.contributionPoints}}

53 |

Contribution Points

54 |
55 |
56 |
57 |
58 |

Interests

59 |
60 | {% for topic,points in usermetrics.topicInterestDict.items %} 61 | 62 |
{{ topic }}
63 | {{ points }} 64 | 65 | {% endfor %} 66 |
67 |

Skills

68 |
69 | {% for topic,skillpoints in usermetrics.topicSkillDict.items %} 70 | 71 |
{{ topic }}
72 | {{ skillpoints }} 73 | 74 | {% endfor %} 75 |
76 |
77 | {%endblock%} 78 | -------------------------------------------------------------------------------- /algorithms/topics.txt: -------------------------------------------------------------------------------- 1 | 3d 2 | activitypub 3 | ai 4 | ajax 5 | algolia 6 | algorithm 7 | amphp 8 | android 9 | angular 10 | ansible 11 | antlr 12 | api 13 | arduino 14 | aspnet 15 | atom 16 | auth0 17 | awesome 18 | aws 19 | azure 20 | babel 21 | backbonejs 22 | bash 23 | basic8 24 | bitcoin 25 | blockchain 26 | bootstrap 27 | bot 28 | c 29 | chrome-extension 30 | chrome 31 | cli 32 | clojure 33 | cms 34 | code-quality 35 | code-review 36 | compiler 37 | composer 38 | computer-vision 39 | conan 40 | contentful 41 | continuous-integration 42 | cpp 43 | cryptocurrency 44 | crystal 45 | csharp 46 | css 47 | cwl 48 | d 49 | data-structures 50 | data-visualization 51 | database 52 | deep-learning 53 | dependency-management 54 | deployment 55 | discord 56 | django 57 | docker 58 | documentation 59 | dotnet 60 | duckduckgo 61 | electron 62 | elixir 63 | emacs 64 | ember 65 | emoji 66 | emulator 67 | es6 68 | eslint 69 | ethereum 70 | express 71 | f-droid 72 | fantasy-console 73 | firebase 74 | firefox-extension 75 | firefox 76 | first-tech-challenge 77 | flask 78 | font 79 | framework 80 | frontend 81 | game-engine 82 | game-off 83 | git 84 | github-api 85 | global-game-jam 86 | go 87 | godot 88 | google-cloud 89 | google 90 | gradle 91 | graphql 92 | gulp 93 | hacktoberfest 94 | haskell 95 | haxe 96 | homebrew 97 | homebridge 98 | html 99 | http 100 | icon-font 101 | image-processing 102 | ios 103 | ipfs 104 | java 105 | javascript 106 | jekyll 107 | jquery 108 | js13kgames 109 | json 110 | julia 111 | jupyter-notebook 112 | kerbal-space-program 113 | koa 114 | kotlin 115 | kubernetes 116 | laravel 117 | latex 118 | less 119 | library 120 | liko-12 121 | lineageos 122 | linux 123 | lisp 124 | localization 125 | lua 126 | ludum-dare 127 | luvit 128 | machine-learning 129 | macos 130 | mahapps 131 | markdown 132 | mastodon 133 | material-design 134 | matlab 135 | maven 136 | minecraft 137 | mobile 138 | monero 139 | mongodb 140 | mongoose 141 | monitoring 142 | mvvmcross 143 | mysql 144 | nativescript 145 | neo 146 | neural-network 147 | nim 148 | nlp 149 | nodejs 150 | nosql 151 | npm 152 | objective-c 153 | ocaml 154 | open-access 155 | opencv 156 | openfin 157 | opengl 158 | operating-system 159 | p2p 160 | package-manager 161 | parsing 162 | perl 163 | perl6 164 | pharo 165 | phaser 166 | php 167 | phpunit 168 | pico-8 169 | pixel-art 170 | pixel-vision-8 171 | postgresql 172 | privacy 173 | probot 174 | project-management 175 | publishing 176 | pwa 177 | python 178 | qt 179 | r 180 | rails 181 | raspberry-pi 182 | ratchet 183 | react-native 184 | react 185 | reactiveui 186 | reactphp 187 | redux 188 | reflex-frp 189 | rest-api 190 | ruby 191 | rust 192 | sass 193 | scala 194 | scikit-learn 195 | sdn 196 | security 197 | server 198 | serverless 199 | shell 200 | sitecore 201 | sketch 202 | spacevim 203 | spring-boot 204 | sql 205 | storybook 206 | sublime-text 207 | support 208 | swift 209 | symfony 210 | tailwind 211 | tbox 212 | telegram 213 | tensorflow 214 | terminal 215 | terraform 216 | testing 217 | thelounge 218 | threejs 219 | tic-80 220 | twitter 221 | typescript 222 | ubuntu 223 | unity 224 | unreal-engine 225 | uportal 226 | userscript 227 | vagrant 228 | vim 229 | virtual-reality 230 | visual-studio-code 231 | vue 232 | wagtail 233 | web-assembly 234 | web-components 235 | webapp 236 | webextension 237 | webpack 238 | windows 239 | wordplate 240 | wordpress 241 | xamarin 242 | xcode 243 | xmake 244 | xml 245 | yii 246 | zeit 247 | -------------------------------------------------------------------------------- /portal/settings.py: -------------------------------------------------------------------------------- 1 | """ 2 | Django settings for portal project. 3 | 4 | Generated by 'django-admin startproject' using Django 2.2.1. 5 | 6 | For more information on this file, see 7 | https://docs.djangoproject.com/en/2.2/topics/settings/ 8 | 9 | For the full list of settings and their values, see 10 | https://docs.djangoproject.com/en/2.2/ref/settings/ 11 | """ 12 | 13 | import os 14 | 15 | # Build paths inside the project like this: os.path.join(BASE_DIR, ...) 16 | BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) 17 | 18 | 19 | # Quick-start development settings - unsuitable for production 20 | # See https://docs.djangoproject.com/en/2.2/howto/deployment/checklist/ 21 | 22 | # SECURITY WARNING: keep the secret key used in production secret! 23 | SECRET_KEY = '_^jj%08k3x(#tg#fqg9#64o041!gtz^x7dxxc=lx1^9!q@ac-s' 24 | 25 | # SECURITY WARNING: don't run with debug turned on in production! 26 | DEBUG = True 27 | 28 | ALLOWED_HOSTS = [] 29 | 30 | 31 | # Application definition 32 | 33 | INSTALLED_APPS = [ 34 | 'django.contrib.admin', 35 | 'django.contrib.auth', 36 | 'django.contrib.contenttypes', 37 | 'django.contrib.sessions', 38 | 'django.contrib.messages', 39 | 'django.contrib.staticfiles', 40 | 'user', 41 | 'algorithms', 42 | 'repo', 43 | 'social_django', 44 | 'accounts.apps.AccountsConfig' 45 | ] 46 | 47 | MIDDLEWARE = [ 48 | 'django.middleware.security.SecurityMiddleware', 49 | 'django.contrib.sessions.middleware.SessionMiddleware', 50 | 'django.middleware.common.CommonMiddleware', 51 | 'django.middleware.csrf.CsrfViewMiddleware', 52 | 'django.contrib.auth.middleware.AuthenticationMiddleware', 53 | 'django.contrib.messages.middleware.MessageMiddleware', 54 | 'django.middleware.clickjacking.XFrameOptionsMiddleware', 55 | 'social_django.middleware.SocialAuthExceptionMiddleware', 56 | ] 57 | 58 | ROOT_URLCONF = 'portal.urls' 59 | 60 | TEMPLATES = [ 61 | { 62 | 'BACKEND': 'django.template.backends.django.DjangoTemplates', 63 | 'DIRS': [os.path.join(BASE_DIR, 'templates')], 64 | 'APP_DIRS': True, 65 | 'OPTIONS': { 66 | 'context_processors': [ 67 | 'django.template.context_processors.debug', 68 | 'django.template.context_processors.request', 69 | 'django.contrib.auth.context_processors.auth', 70 | 'django.contrib.messages.context_processors.messages', 71 | 'social_django.context_processors.backends', 72 | 'social_django.context_processors.login_redirect', 73 | ], 74 | }, 75 | }, 76 | ] 77 | 78 | WSGI_APPLICATION = 'portal.wsgi.application' 79 | 80 | 81 | # Database 82 | # https://docs.djangoproject.com/en/2.2/ref/settings/#databases 83 | 84 | DATABASES = { 85 | 'default': { 86 | 'ENGINE': 'django.db.backends.sqlite3', 87 | 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'), 88 | } 89 | } 90 | 91 | 92 | # Password validation 93 | # https://docs.djangoproject.com/en/2.2/ref/settings/#auth-password-validators 94 | 95 | AUTH_PASSWORD_VALIDATORS = [ 96 | { 97 | 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator', 98 | }, 99 | { 100 | 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', 101 | }, 102 | { 103 | 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator', 104 | }, 105 | { 106 | 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator', 107 | }, 108 | ] 109 | 110 | AUTHENTICATION_BACKENDS = ( 111 | 'social_core.backends.github.GithubOAuth2', # for Github authentication 112 | 113 | 'django.contrib.auth.backends.ModelBackend', 114 | ) 115 | # Internationalization 116 | # https://docs.djangoproject.com/en/2.2/topics/i18n/ 117 | 118 | LANGUAGE_CODE = 'en-us' 119 | 120 | TIME_ZONE = 'UTC' 121 | 122 | USE_I18N = True 123 | 124 | USE_L10N = True 125 | 126 | USE_TZ = True 127 | 128 | 129 | # Static files (CSS, JavaScript, Images) 130 | # https://docs.djangoproject.com/en/2.2/howto/static-files/ 131 | 132 | STATIC_URL = '/static/' 133 | STATIC_ROOT = os.path.join(BASE_DIR, 'static') 134 | 135 | LOGIN_URL = 'accounts/login' 136 | LOGOUT_URL = 'logout' 137 | 138 | LOGIN_REDIRECT_URL = '/' 139 | LOGOUT_REDIRECT_URL = '/' 140 | 141 | SOCIAL_AUTH_GITHUB_KEY = '' 142 | SOCIAL_AUTH_GITHUB_SECRET = '' -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # GitLit :fire: 2 | [![Watchers][watchers-badge]][watchers] 3 | [![Star Gazers][stars-badge]][stargazers] 4 | [![Forks][forks-badge]][forks] 5 | 6 | ![Status](https://img.shields.io/badge/Status-Under_Development-Red.svg) 7 | ![Version 0.1](https://img.shields.io/badge/Version-0.1_(Alpha)-green.svg) 8 | [![GNU][license-badge]][license] 9 | [![Open Issues][issues-badge]][issues] 10 | [![PRs][pr-badge]][prs] 11 | [![Contributors][contributors-badge]][contributors] 12 | 13 | 14 | GitLit is a social network exclusively for Open-Source developers. It works by connecting enthusiastic developers to the most interesting and relevant projects to them and forming new communities of like-minded and passionate developers. 15 | 16 | ## :thinking: Why GitLit? 17 | 18 | 1. **It is difficult to find contributable projects** - What if you can get a dashboard full of project and issues suggestions, which are relevant to you - both skill and interest wise? 19 | 20 | 2. **There is no standards to rate and classify developers & projects** 21 | 22 | ## :star2: Top Features 23 | 1. Advanced Rating System for Contributor's & Repositories on GitHub 24 | 2. Intelligent Identification of Contributor's Interest & Skills 25 | 3. Smart & Relevant Mapping of Repositories & Contributor's based on shared interests and skill-level. 26 | 4. Suggestion feed of contributable repositories, and notifications for fixable issues 27 | 5. View similar repositories and users 28 | 6. Intelligent Insights with actionable feedbacks & checklist for contributors and repositories 29 | 30 | ## :bowtie: Target Users 31 | There are two primary use-cases for GitLit, one for the developers to discover interesting projects and the other is for 32 | people in the industry to find talented and enthusiastic developers. 33 | 34 | **Project Discovery** 35 | 36 | * **Students & Beginners:** GitLit can be used by students and beginners to get started into the world of Open Source. 37 | It helps them to break-the-ice, and kick-start their FOSS journey without essentially going into deeper level. 38 | 39 | * **Developers** GitLit can also be used by amateur as well as professional developers to discover innovative, interesting 40 | and relevant projects to contribute to - based on their skill level. 41 | 42 | **Developer Discovery** 43 | 44 | * **Developer Advocates:** GitLit can be used by developer advocates to identify enthusiastic and talented 45 | contributors, who are interested in their organization, and connect with them. It can be also used by them to analyse 46 | their projects, and monitor community members. 47 | 48 | * **College Clubs:** College based computer clubs like [amFOSS](http://amfoss.in/), can use GitLit to identify enthusiastic and talented 49 | students out of a large pool and effectively monitor and check their progress. 50 | 51 | * **Corporate Recruiters:** Corporate companies can discover developers, with the required talent and passion using 52 | credible metrics of GitLit. 53 | 54 | ## :bookmark_tabs: Documentation 55 | * **Algorithms** 56 | * **Documentation** 57 | * [**Working Code**](/algorithms/README.MD) 58 | * **Data Sourcing & Processing** 59 | * [**GitHub API**](https://github.com/teamdeadlock/GitLit/wiki/GitHub-API) 60 | * **Limitations in Sourcing & Processing** 61 | * **Rating Metrics** 62 | * [**User Metrics**](https://github.com/teamdeadlock/GitLit/wiki/Metrics:-Repository-Metrics) 63 | * [**Repository Metrics**](https://github.com/teamdeadlock/GitLit/wiki/Metrics:-Repository-Metrics) 64 | * **Interest Identification** 65 | * **Using GitHub Topics as basis for Interest Classfication** 66 | * [**Finding User's Topics of Interest**](https://github.com/teamdeadlock/GitLit/wiki/Topics:-Identifying-Project-Topics) 67 | * [**Weighting Topics of Interest**](https://github.com/teamdeadlock/GitLit/wiki/Topics:-Weighting-Topics-of-Interest) 68 | * [**Identification of Project Topics**](https://github.com/teamdeadlock/GitLit/wiki/Topics:-Identifying-Project-Topics) 69 | * **Matching & Mapping** 70 | 71 | ## :electric_plug: How it Works? 72 | 73 | ### Suggestion Panel to help developers 74 | 1. Fetches all data about a developer, once a developer signs-up. 75 | 2. After analysing his previous contribution pattern, an complex algorithm rates the developer using smart metrics, and classifies him into interest groups. 76 | 3. Based on his interests, and his skill in the given topic of interest, an ML-based matching algorithm matches it with most relevant projects 77 | 4. The developer recieves relevant and interesting suggestions for projects, and issues. 78 | 79 | ### Discovery Panel to help projects 80 | 81 | 82 | ## :nut_and_bolt: Tech Stack 83 | 84 | * **Language:** Python 3.6 85 | * **Framework (full-stack):** Django 86 | * **API:** GraphQL (Github API 4), Rest API (Github API 3) 87 | * **Frontend Frameworks:** Bootstrap 4 88 | * **Javascript Libraries:** jQuery 89 | * **Stylesheet Pre-processors:** Sass 90 | 91 | 92 | ## :busts_in_silhouette: Creators 93 | 94 | 1. [Venu Vardhan Reddy](https://github.com/vchrombie) 95 | 2. [Akhil K Gangadharan](https://github.com/akhilam512) 96 | 3. [Ashwin S Shenoy](https://github.com/aswinshenoy) 97 | 98 | ## :man_technologist: Core Contributors 99 | 100 | 1. [Puneeth Chanda](https://github.com/puneeth2001) 101 | 102 | 103 | Contributions are welcome! <3 104 | 105 | ## :black_nib: License 106 | [GNU General Public License v3.0](/LICENSE) 107 | 108 | [contributors-badge]:https://img.shields.io/github/contributors/amfoss/gitlit.svg 109 | [contributors]: https://github.com/amfoss/GitLit/graphs/contributors 110 | [watchers-badge]:https://img.shields.io/github/watchers/amfoss/gitlit.svg?style=social 111 | [watchers]: https://github.com/amfoss/GitLit/watchers 112 | [stars-badge]:https://img.shields.io/github/stars/amfoss/gitlit.svg?style=social 113 | [stargazers]:https://github.com/amfoss/GitLit/stargazers 114 | [forks-badge]: https://img.shields.io/github/forks/amfoss/gitlit.svg?style=social 115 | [forks]: https://github.com/amfoss/GitLit/network/members 116 | [license-badge]: https://img.shields.io/github/license/amfoss/gitlit.svg 117 | [license]: https://github.com/amfoss/gitlit/blob/master/LICENSE 118 | [issues-badge]: https://img.shields.io/github/issues/amfoss/gitlit.svg 119 | [issues]: https://github.com/amfoss/gitlit/issues 120 | [pr-badge]:https://img.shields.io/github/issues-pr/amfoss/gitlit.svg 121 | [prs]: https://github.com/amfoss/gitlit/pulls 122 | 123 | -------------------------------------------------------------------------------- /algorithms/script.py: -------------------------------------------------------------------------------- 1 | import requests 2 | import json 3 | import collections 4 | 5 | accessToken = "" 6 | headers = {"Authorization": "bearer "+ accessToken } 7 | 8 | class userTopicResult: 9 | def __init__(self, username, userTopics): 10 | self.username = str(username) 11 | self.userTopics = list(userTopics) 12 | self.userTopicSkill = 0 13 | self.getTopicList() 14 | self.setSkillPoints() 15 | 16 | 17 | def getTopicList(self): 18 | selfTopicList = list() #topics of the user repos 19 | contributedTopicList = list() #topics of the user contributed repos 20 | starredTopicList = list() #topics which the user has starred 21 | 22 | topicOccurenceSelf = dict() 23 | topicOccurenceContributed = dict() 24 | topicOccurenceStarred = dict() 25 | 26 | self.topicInterestDict = dict() #final dict!! 27 | 28 | topic_query = """ 29 | { 30 | user(login:""" + '"' + self.username + '"' + """) 31 | { 32 | starredRepositories(last: 100) { 33 | nodes { 34 | repositoryTopics(first: 100) { 35 | nodes { 36 | topic { 37 | name 38 | } 39 | } 40 | } 41 | } 42 | } 43 | repositories(last: 100) { 44 | nodes { 45 | languages(first: 3) 46 | { 47 | nodes 48 | { 49 | name 50 | } 51 | } 52 | repositoryTopics(first: 100) { 53 | nodes { 54 | topic { 55 | name 56 | } 57 | } 58 | } 59 | } 60 | } 61 | repositoriesContributedTo(last: 100) { 62 | nodes { 63 | languages(first: 3) 64 | { 65 | nodes 66 | { 67 | name 68 | } 69 | } 70 | repositoryTopics(first: 100) { 71 | nodes { 72 | topic { 73 | name 74 | } 75 | } 76 | } 77 | } 78 | } 79 | } 80 | } 81 | """ 82 | 83 | request = requests.post('https://api.github.com/graphql', json={'query': topic_query}, headers=headers) 84 | 85 | if request.status_code == 200: 86 | result = request.json() 87 | if result["data"]["user"]["starredRepositories"]["nodes"]: 88 | for i in result["data"]["user"]["starredRepositories"]["nodes"]: 89 | for j in i["repositoryTopics"]["nodes"]: 90 | starredTopicList.append(j["topic"]["name"]) 91 | if result["data"]["user"]["repositories"]["nodes"]: 92 | for i in result["data"]["user"]["repositories"]["nodes"]: 93 | for j in i["repositoryTopics"]["nodes"]: 94 | selfTopicList.append(j["topic"]["name"]) 95 | if result["data"]["user"]["repositoriesContributedTo"]["nodes"]: 96 | for i in result["data"]["user"]["repositoriesContributedTo"]["nodes"]: 97 | for j in i["repositoryTopics"]["nodes"]: 98 | contributedTopicList.append(j["topic"]["name"]) 99 | 100 | 101 | fileTopicList = open("algorithms/topics.txt", "r").read().split('\n') 102 | 103 | topicOccurenceSelf = dict(collections.Counter(x for x in selfTopicList if x)) 104 | topicOccurenceContributed = dict(collections.Counter(x for x in contributedTopicList if x)) 105 | topicOccurenceStarred = dict(collections.Counter(x for x in starredTopicList if x)) 106 | 107 | self.skillSelf = topicOccurenceSelf # we are using this to calculate skill points down there 108 | #topicOccurenceSelf 4 109 | #topicOccurenceContributed 3 110 | #topicOccurenceStarred 1 111 | 112 | def removeIrrelevant(topicDict): 113 | to_delete = set(topicDict.keys()).difference(fileTopicList) #removing A-B from A 114 | for d in to_delete: 115 | del topicDict[d] 116 | 117 | removeIrrelevant(topicOccurenceSelf) 118 | removeIrrelevant(topicOccurenceContributed) 119 | removeIrrelevant(topicOccurenceStarred) 120 | 121 | 122 | def updateValue(topicDict): 123 | for topic in topicDict.keys(): 124 | if topic not in self.topicInterestDict.keys(): 125 | value = 0 126 | if topic in topicOccurenceSelf.keys(): 127 | value = value + 4*topicOccurenceSelf[topic] 128 | if topic in topicOccurenceContributed.keys(): 129 | value = value +3*topicOccurenceContributed[topic] 130 | if topic in topicOccurenceStarred.keys(): 131 | value = value +1*topicOccurenceStarred[topic] 132 | self.topicInterestDict[topic]=value 133 | 134 | updateValue(topicOccurenceSelf) 135 | updateValue(topicOccurenceContributed) 136 | updateValue(topicOccurenceStarred) 137 | 138 | self.topicInterestDict = dict(sorted(self.topicInterestDict.items(), key=lambda x: x[1], reverse=True)) 139 | 140 | def setSkillPoints(self): 141 | 142 | topicSkillDict = dict() 143 | 144 | prm_query = """ 145 | { 146 | user(login:""" + '"' + self.username + '"' + """) 147 | { 148 | pullRequests(last: 100, states: MERGED) { 149 | nodes { 150 | repository { 151 | repositoryTopics(first: 100) { 152 | nodes { 153 | topic { 154 | name 155 | } 156 | } 157 | } 158 | } 159 | } 160 | } 161 | issues(last: 100, states: CLOSED) { 162 | nodes { 163 | repository { 164 | repositoryTopics(first: 100) { 165 | nodes { 166 | topic { 167 | name 168 | } 169 | } 170 | } 171 | } 172 | } 173 | } 174 | } 175 | } 176 | """ 177 | 178 | request = requests.post('https://api.github.com/graphql', json={'query': prm_query}, headers=headers) 179 | 180 | PRtopicList = list() 181 | PRtopicDict = dict() 182 | 183 | issueTopicList = list() 184 | issueTopicDict = dict() 185 | 186 | topicPRs = dict() 187 | 188 | if request.status_code == 200: 189 | result = request.json() 190 | 191 | for i in result["data"]["user"]["pullRequests"]["nodes"]: 192 | for j in i["repository"]["repositoryTopics"]["nodes"]: 193 | PRtopicList.append( j["topic"]["name"]) 194 | 195 | for i in result["data"]["user"]["issues"]["nodes"]: 196 | for j in i["repository"]["repositoryTopics"]["nodes"]: 197 | issueTopicList.append( j["topic"]["name"]) 198 | 199 | PRtopicDict = dict(collections.Counter(x for x in PRtopicList if x)) 200 | issueTopicDict = dict(collections.Counter(x for x in issueTopicList if x)) 201 | 202 | def updateSkillsetValue(topicDict): 203 | for topic in topicDict.keys(): 204 | if topic not in topicSkillDict.keys() and topic in self.topicInterestDict.keys(): 205 | value = 0 206 | if topic in PRtopicDict.keys(): 207 | value = value + PRtopicDict[topic] 208 | if topic in issueTopicDict.keys(): 209 | value = value +issueTopicDict[topic] 210 | if topic in self.skillSelf.keys(): 211 | value = value + 0.5*self.skillSelf[topic] 212 | topicSkillDict[topic]=value 213 | 214 | updateSkillsetValue(PRtopicDict) 215 | updateSkillsetValue(issueTopicDict) 216 | updateSkillsetValue(self.skillSelf) 217 | for topic in self.userTopics: 218 | if topic in topicSkillDict.keys(): 219 | self.userTopicSkill = self.userTopicSkill + topicSkillDict[topic] 220 | -------------------------------------------------------------------------------- /algorithms/README.MD: -------------------------------------------------------------------------------- 1 | # GitLit Algorithms 2 | 3 | 4 | ## Rating Algorithms 5 | Each metric defined below has its own specific API query. The process is simple : we fetch the data from GitHub APIs which is already streamlined for a specific metric, cut down the data further (if needed) and then assign appropriate weights to these numbers to form a score of a User or a Repo. 6 | 7 | ----------------------------------------------------------------------------------------- 8 | 9 | ## User Rating 10 | A total of 5 metrics have been designed to rate the user and the algorithms are designed according to the process mentioned above. 11 | 12 | Each score is a boundless score calculated by summation of weighted sums of each of the following metric. 13 | 14 | ----------------------------------------------------------------------------------------- 15 | 16 | ### General traits 17 | 1. Contribution Count 18 | 19 | *Motive : To get a base idea of a given user* 20 | 21 | | Weight | Formula | 22 | | -------|---------------------------------- | 23 | | 3 | Number of Commits | 24 | | 3 | Number of PRs | 25 | | 2 | Number of Issues | 26 | | 2 | Number of User Repos | 27 | | 3 | Number of Repos contributed to | 28 | 29 | #### Base Score 30 | 31 | 32 | 33 | ----------------------------------------------------------------------------------------- 34 | 35 | ### Creation 36 | 37 | 1. Stars - Repo Ratio 38 | 39 | *Motive : To get the value of projects created* 40 | 41 | | Weight | Formula | 42 | | -------|---------------------------------- | 43 | | 1 | | 44 | 45 | 46 | #### Creation Score 47 | 48 | | 49 | 50 | ----------------------------------------------------------------------------------------- 51 | 52 | ### Contribution 53 | 1. PR Acceptance Ratio: 54 | 55 | *Motive : Value of Contribution* 56 | 57 | | Weight | Formula | 58 | | -------|---------------------------------- | 59 | | 3 | | 60 | 61 | 62 | 2. Issue Acceptance Ratio: 63 | 64 | *Motive : Value of Contribution* 65 | 66 | | Weight | Formula | 67 | | -------|---------------------------------- | 68 | | 2 | | 69 | 70 | 71 | #### Contribution Score 72 | 73 | 74 | ----------------------------------------------------------------------------------------- 75 | 76 | ### Community 77 | 1. Number of followers/following/organisations involved in. 78 | *Motive : to get impact in community* 79 | 80 | | Weight | Formula | 81 | | -------|---------------------------------- | 82 | | 10 | Number of Organisations | 83 | | 2 | Number of Followers | 84 | | 1 | Number of Following | 85 | 86 | #### Community Score 87 | 88 | 89 | ----------------------------------------------------------------------------------------- 90 | 91 | ### Activity 92 | 1. Annual merged PRs 93 | *Motive : to get to know how active the user is* 94 | 95 | | Weight | Formula | 96 | | -------|---------------------------------- | 97 | | 3 | Number of PRs merged in an year | 98 | 99 | 2. Annual raised Issues 100 | *Motive : to get to know how active the user is* 101 | 102 | | Weight | Formula | 103 | | -------|---------------------------------- | 104 | | 2 | Number of PRs merged in an year | 105 | 106 | 107 | #### Activity Score 108 | 109 | ----------------------------------------------------------------------------------------- 110 | 111 | ### User Score 112 | 113 | ----------------------------------------------------------------------------------------- 114 | 115 | 116 | ### Skill Score 117 | 118 | First, skill score is calculated for each topic the User is interested in : 119 | 120 | | Weight | Contribution | 121 | |-------- | -----------------| 122 | | 1 | Number of PRs | 123 | | 1 | Number of Issues| 124 | 125 | SKill score for a topic is finally calculated as : 126 | 127 | 128 | 129 | ----------------------------------------------------------------------------------------- 130 | 131 | ## Repository Rating 132 | 133 | ### General Traits 134 | 135 | 1. General activity and relevance of repo 136 | 137 | *Motive : To get a basic idea* 138 | 139 | | Weight | Trait | 140 | |-------- | ------------------ | 141 | | 3 | Number of watchers | 142 | | 2 | Numer of stars | 143 | | 5 | Number of PRs | 144 | | 1.5 | Number of forks | 145 | | 4 | Number of issues | 146 | 147 | #### Base Score 148 | 149 | 150 | ----------------------------------------------------------------------------------------- 151 | 152 | ### Actvity 153 | 154 | 1. Average Issue Resolution Time 155 | 156 | *Motive : To weigh the response time* 157 | 158 | | Weight | Formula | 159 | |-------- | ------------------ | 160 | | 8 | | 161 | 162 | Average Issue Resolution Score is calculated from the above formula based on the following conditions : 163 | 164 | | Average Issue Resolution Time ( in days ) | Score | 165 | | ------------------------------------------- | ------- | 166 | | less than or equal to 20 | 20 | 167 | | less than or equal to 50 | 10 | 168 | | greater than 50 | 5 | 169 | 170 | 2. Weekly Contributor Count 171 | 172 | *Motive : To acount for contributor activity* 173 | 174 | (*Note : A contributor,here, means anyone who has created an Issue or a PR*) 175 | 176 | 177 | | Weight | Formula | 178 | |-------- | ------------------ | 179 | | 5 | | 180 | 181 | 3. Weekly Contributor Change 182 | 183 | *Motive : To acount for contributor activity* 184 | 185 | | Weight | Formula | 186 | |-------- | ------------------ | 187 | | 8 | | 188 | 189 | 190 | #### Activity Score 191 | 192 | 193 | 194 | 195 | ----------------------------------------------------------------------------------------- 196 | 197 | ### Inclusivity 198 | 199 | 1. PR Acceptance Ratio 200 | 201 | *Motive : To account for new code submitted w.r.t old code* 202 | 203 | | Weight | Formula | 204 | |-------- | ------------------ | 205 | | 8 | | 206 | 207 | 2. New Contributor Count 208 | 209 | *Motive : To account for first time contributors to repo in the week* 210 | 211 | | Weight | Formula | 212 | |-------- | ------------------ | 213 | | 4 | | 214 | 215 | #### Inclusivity Score 216 | 217 | 218 | 219 | ----------------------------------------------------------------------------------------- 220 | 221 | 222 | ### Merit 223 | 224 | 1. Complexity of Repo 225 | 226 | It is estimated by calcuating the Skill Points of the top 10 contributors of the repo in the topics the Repo and the Contributors both share. 227 | 228 | 229 | 230 | #### Merit Score 231 | 232 | 233 | 234 | ----------------------------------------------------------------------------------------- 235 | 236 | 237 | ### Total Repo Score 238 | 239 | 240 | 241 | 242 | 243 | ----------------------------------------------------------------------------------------- 244 | 245 | 246 | 247 | 248 | -------------------------------------------------------------------------------- /algorithms/repository_rating.py: -------------------------------------------------------------------------------- 1 | """ 2 | 3 | annualActivityScoreSITORY RATING ALGORITHM 4 | 5 | """ 6 | import json 7 | from datetime import timedelta, datetime 8 | from dateutil import parser, relativedelta 9 | from algorithms.script import userTopicResult 10 | 11 | 12 | import requests 13 | 14 | 15 | 16 | class RepositoryMetrics: 17 | 18 | def __init__(self, name, owner, token): 19 | # initialize class variables 20 | self.name = str(name) 21 | self.owner = str(owner) 22 | self.token = str(token) 23 | self.reponame = self.name + '-' + self.owner 24 | self.headers = {"Authorization": "bearer " + self.token} 25 | 26 | # User Profile Details 27 | self.fullName = '' 28 | self.userID = '' # used getting avatar 29 | 30 | self.topicsList = list() 31 | 32 | # Repo Statistics 33 | self.commitCount = 0 34 | self.prCount = 0 35 | self.prMergedCount = 0 36 | self.issueCount = 0 37 | self.branchCount = 0 38 | self.maintainersCount = 0 39 | 40 | self.weeklyContributorsCount = 0 41 | self.weeklyContributorsChange = 0 42 | self.firstTimeContributorsThisWeek = 0 43 | 44 | self.weeklyContributorNames = list() 45 | self.totalContributors = list() 46 | 47 | # Initializing User Points 48 | self.basePoints = 0 49 | self.activityPoints = 0 50 | self.popularityPoints = 0 51 | self.inclusivityPoints = 0 52 | self.meritPoints = 0 53 | self.repoPoints = 0 54 | 55 | # run class functions 56 | self.fetchBasicDetails() 57 | self.calcActivityScore() 58 | self.calcInclusivityScore() 59 | self.calcMeritScore() 60 | 61 | # calculate final score 62 | self.calcRepoScore() 63 | 64 | def fetchBasicDetails(self): 65 | query =""" 66 | { 67 | repository(name: """ + '"' + str(self.name) + '"' + """, owner: """ + '"' + str(self.owner) + '"' + """) 68 | { 69 | stargazers { 70 | totalCount 71 | } 72 | watchers { 73 | totalCount 74 | } 75 | forkCount 76 | 77 | pullRequests 78 | { 79 | totalCount 80 | } 81 | 82 | issues 83 | { 84 | totalCount 85 | } 86 | } 87 | } 88 | """ 89 | 90 | request = requests.post('https://api.github.com/graphql', json={'query': query}, headers=self.headers) 91 | 92 | if request.status_code == 200: 93 | result = request.json() 94 | if(result is not None): 95 | stargazers = result["data"]["repository"]["stargazers"]["totalCount"] 96 | else: 97 | stargazers = 0 98 | watchers = result["data"]["repository"]["watchers"]["totalCount"] 99 | forkCount = result["data"]["repository"]["forkCount"] 100 | self.prCount = result["data"]["repository"]["pullRequests"]["totalCount"] 101 | issueCount = result["data"]["repository"]["issues"]["totalCount"] 102 | 103 | self.basePoints = round(0.3 * watchers + 0.2 * stargazers + 0.15 * forkCount +0.5*self.prCount + 0.4*issueCount, 4) #phase 1 done 104 | 105 | 106 | 107 | 108 | 109 | 110 | def calcActivityScore(self): 111 | query = """ 112 | { 113 | repository(name: """ + '"' + str(self.name) + '"' + """, owner: """ + '"' + str(self.owner) + '"' + """) 114 | { 115 | issues(last:100, states: CLOSED) 116 | { 117 | edges{ 118 | node 119 | { 120 | createdAt 121 | closedAt 122 | } 123 | 124 | } 125 | 126 | } 127 | } 128 | } 129 | """ 130 | request = requests.post('https://api.github.com/graphql', json={'query': query}, headers=self.headers) 131 | 132 | if request.status_code == 200: 133 | result = request.json() 134 | total = timedelta(microseconds=1) 135 | count = 0 136 | 137 | if(result["data"]["repository"]["issues"]["edges"] is not None): 138 | 139 | for issue in result["data"]["repository"]["issues"]["edges"]: 140 | count = count +1 141 | created = parser.parse(issue["node"]["createdAt"]) 142 | closed = parser.parse(issue["node"]["closedAt"]) 143 | total = total + closed-created 144 | 145 | if(count>0): 146 | avgIssueResolutionTime = total/count 147 | else: 148 | avgIssueResolutionTime = -1 149 | 150 | else: 151 | avgIssueResolutionTime = -1 152 | 153 | 154 | 155 | 156 | query =""" 157 | { 158 | repository(name: """ + '"' + str(self.name) + '"' + """, owner: """ + '"' + str(self.owner) + '"' + """) 159 | { 160 | pullRequests(last:100) 161 | { 162 | edges 163 | { 164 | node 165 | { 166 | createdAt 167 | author 168 | { 169 | login 170 | } 171 | } 172 | cursor 173 | } 174 | } 175 | issues(last:100) 176 | { 177 | edges 178 | { 179 | node 180 | { 181 | createdAt 182 | author 183 | { 184 | login 185 | } 186 | } 187 | cursor 188 | } 189 | } 190 | } 191 | } 192 | """ 193 | request = requests.post('https://api.github.com/graphql', json={'query': query}, headers=self.headers) 194 | 195 | if request.status_code == 200: 196 | result = request.json() 197 | 198 | clist = list() 199 | for contributor in result["data"]["repository"]["pullRequests"]["edges"]: 200 | created_at = parser.parse(contributor["node"]["createdAt"]) 201 | timezone = created_at.tzinfo 202 | time_now = datetime.now(timezone) 203 | weekago = time_now - relativedelta.relativedelta(days=7) 204 | 205 | if(created_at>weekago): 206 | user = contributor["node"]["author"]["login"] 207 | if(user not in clist): 208 | clist.append(user) 209 | 210 | for contributor in result["data"]["repository"]["issues"]["edges"]: 211 | created_at = parser.parse(contributor["node"]["createdAt"]) 212 | timezone = created_at.tzinfo 213 | time_now = datetime.now(timezone) 214 | weekago = time_now - relativedelta.relativedelta(days=7) 215 | 216 | if(created_at>weekago): 217 | user = contributor["node"]["author"]["login"] 218 | if(user not in clist): 219 | clist.append(user) 220 | 221 | # Add New Users 222 | for user in clist: 223 | if(user not in self.weeklyContributorNames): 224 | self.weeklyContributorNames.append(user) 225 | 226 | if(user not in self.totalContributors): 227 | self.totalContributors.append(user) 228 | 229 | # Remove Old Users 230 | for user in self.weeklyContributorNames: 231 | if(user not in clist): 232 | self.weeklyContributorNames.remove(user) 233 | 234 | self.weeklyContributorsChange = len(clist) - self.weeklyContributorsCount 235 | self.weeklyContributorsCount = len(clist) 236 | 237 | # -- ok 238 | 239 | numberOfDays = int(str(avgIssueResolutionTime)[0:2]) 240 | if (numberOfDays) <= 20: 241 | avgIssueResolutionScore = 20 242 | elif (numberOfDays) <= 50: 243 | avgIssueResolutionScore = 10 244 | else: 245 | avgIssueResolutionScore = 5 246 | 247 | 248 | self.activityPoints = 8*avgIssueResolutionScore + 5*self.weeklyContributorsCount + 8*self.weeklyContributorsChange 249 | 250 | 251 | 252 | def calcInclusivityScore(self): 253 | merged_prs_query = """ 254 | { 255 | repository(name: """ + '"' + str(self.name) + '"' + """, owner: """ + '"' + str(self.owner) + '"' + """) 256 | { 257 | pullRequests(states: MERGED) 258 | { 259 | totalCount 260 | } 261 | 262 | } 263 | } 264 | """ 265 | total_prs_query = """ 266 | { 267 | repository(name: """ + '"' + str(self.name) + '"' + """, owner: """ + '"' + str(self.owner) + '"' + """) 268 | { 269 | pullRequests 270 | { 271 | totalCount 272 | } 273 | 274 | } 275 | } 276 | """ 277 | mergedPR = requests.post('https://api.github.com/graphql', json={'query': merged_prs_query}, headers=self.headers) 278 | totalPR = requests.post('https://api.github.com/graphql', json={'query': total_prs_query}, headers=self.headers) 279 | 280 | if totalPR.status_code == 200 and mergedPR.status_code ==200: 281 | PRmergedData = mergedPR.json() 282 | PRtotalData = totalPR.json() 283 | self.prMergedCount = PRmergedData["data"]["repository"]["pullRequests"]["totalCount"] 284 | self.totalprCount = PRtotalData["data"]["repository"]["pullRequests"]["totalCount"] 285 | 286 | if(self.totalprCount>0): 287 | PRacceptanceRatio = round( self.prMergedCount/self.totalprCount, 2) 288 | else: 289 | PRacceptanceRatio = -1 290 | 291 | else: 292 | PRacceptanceRatio = -1 293 | 294 | 295 | # new contributors below 296 | 297 | for user in self.weeklyContributorNames: 298 | query = """ 299 | { 300 | user(login:""" + user +"""){ 301 | 302 | pullRequests(first:100) 303 | { 304 | nodes 305 | { 306 | createdAt 307 | repository { 308 | nameWithOwner 309 | } 310 | } 311 | } 312 | } 313 | } 314 | """ 315 | request = requests.post('https://api.github.com/graphql', json={'query': query}, headers=self.headers) 316 | 317 | if request.status_code == 200: 318 | flag = 0 319 | result = request.json() 320 | if(result["data"]): 321 | for prs in result["data"]["user"]["pullRequests"]["nodes"]: 322 | rep_name = prs["repository"]["nameWithOwner"] 323 | created_at = parser.parse(prs["createdAt"]) 324 | timezone = created_at.tzinfo 325 | time_now = datetime.now(timezone) 326 | weekago = time_now - relativedelta.relativedelta(days=7) 327 | if(created_at0: 162 | self.creationPoints = (2 * repoStarsCount/self.repoOwnCount) * self.repoOwnCount 163 | else: 164 | self.creationPoints = 0.5 * self.repoOwnCount 165 | else: 166 | self.creationPoints = self.repoOwnCount 167 | 168 | def calcActivityScore(self): 169 | pr_query = """ 170 | { 171 | user(login:""" + '"' + self.username + '"' + """) 172 | { 173 | pullRequests(last:100,states:MERGED) 174 | { 175 | edges{ 176 | node 177 | { 178 | createdAt 179 | } 180 | } 181 | } 182 | 183 | } 184 | } 185 | """ 186 | response = runquery(self.token, pr_query) 187 | if response: 188 | count = 0 189 | if response["data"]["user"]["pullRequests"]["edges"]: 190 | for pr in response["data"]["user"]["pullRequests"]["edges"]: 191 | created = parser.parse(pr["node"]["createdAt"]) 192 | timezone = created.tzinfo 193 | time_now = datetime.now(timezone) 194 | yearago = time_now - relativedelta.relativedelta(year=1) 195 | 196 | if (created > yearago): 197 | count = count + 1 198 | 199 | annualPRmergedCount = count 200 | 201 | issue_query = """ 202 | { 203 | user(login:""" + '"' + self.username + '"' + """) 204 | { 205 | issues(last:100,states:CLOSED) 206 | { 207 | edges{ 208 | node 209 | { 210 | createdAt 211 | } 212 | } 213 | } 214 | 215 | } 216 | } 217 | """ 218 | response = runquery(self.token, issue_query) 219 | if response: 220 | count = 0 221 | if (response["data"]["user"]["issues"]["edges"]): 222 | for pr in response["data"]["user"]["issues"]["edges"]: 223 | created = parser.parse(pr["node"]["createdAt"]) 224 | timezone = created.tzinfo 225 | time_now = datetime.now(timezone) 226 | yearago = time_now - relativedelta.relativedelta(year=1) 227 | 228 | if (created > yearago): 229 | count = count + 1 230 | 231 | annualIssuesRaised = count 232 | 233 | self.activityPoints = 3 * annualPRmergedCount + 2 * annualIssuesRaised 234 | 235 | def calcContributionScore(self): 236 | query = """ 237 | { 238 | user(login:""" + '"' + self.username + '"' + """) 239 | { 240 | pullRequests(states:MERGED) 241 | { 242 | totalCount 243 | } 244 | issues(states:CLOSED) 245 | { 246 | totalCount 247 | } 248 | } 249 | } 250 | """ 251 | response = runquery(self.token, query) 252 | if response: 253 | self.PRmergedCount = response["data"]["user"]["pullRequests"]["totalCount"] 254 | self.IssuesMergedCount = response["data"]["user"]["pullRequests"]["totalCount"] 255 | 256 | if self.prCount > 0: 257 | PRscore = ((self.PRmergedCount) ** 2) / self.prCount 258 | else: 259 | PRscore = 0 260 | 261 | if self.issueCount > 0: 262 | IssueScore = ((self.IssuesMergedCount) ** 2) / self.issueCount 263 | else: 264 | IssueScore = 0 265 | 266 | self.contributionPoints = round(0.3 * PRscore + 0.2 * IssueScore,2) 267 | 268 | def calcUserScore(self): 269 | self.userPoints = round(0.5 * self.basePoints + 2 * self.creationPoints + self.activityPoints + 2 * self.contributionPoints,2) 270 | 271 | def getTopicList(self): 272 | selfTopicList = list() # topics of the user repos 273 | contributedTopicList = list() # topics of the user contributed repos 274 | starredTopicList = list() # topics which the user has starred 275 | 276 | topicOccurenceSelf = dict() 277 | topicOccurenceContributed = dict() 278 | topicOccurenceStarred = dict() 279 | 280 | self.topicInterestDict = dict() # final dict!! 281 | 282 | topic_query = """ 283 | { 284 | user(login:""" + '"' + self.username + '"' + """) 285 | { 286 | starredRepositories(last: 100) { 287 | nodes { 288 | repositoryTopics(first: 100) { 289 | nodes { 290 | topic { 291 | name 292 | } 293 | } 294 | } 295 | } 296 | } 297 | repositories(last: 100) { 298 | nodes { 299 | languages(first: 3) 300 | { 301 | nodes 302 | { 303 | name 304 | } 305 | } 306 | repositoryTopics(first: 100) { 307 | nodes { 308 | topic { 309 | name 310 | } 311 | } 312 | } 313 | } 314 | } 315 | repositoriesContributedTo(last: 100) { 316 | nodes { 317 | languages(first: 3) 318 | { 319 | nodes 320 | { 321 | name 322 | } 323 | } 324 | repositoryTopics(first: 100) { 325 | nodes { 326 | topic { 327 | name 328 | } 329 | } 330 | } 331 | } 332 | } 333 | } 334 | } 335 | """ 336 | 337 | result = runquery(self.token, topic_query) 338 | if result: 339 | for i in result["data"]["user"]["starredRepositories"]["nodes"]: 340 | for j in i["repositoryTopics"]["nodes"]: 341 | starredTopicList.append(j["topic"]["name"]) 342 | 343 | for i in result["data"]["user"]["repositories"]["nodes"]: 344 | for j in i["repositoryTopics"]["nodes"]: 345 | selfTopicList.append(j["topic"]["name"]) 346 | 347 | for i in result["data"]["user"]["repositoriesContributedTo"]["nodes"]: 348 | for j in i["repositoryTopics"]["nodes"]: 349 | contributedTopicList.append(j["topic"]["name"]) 350 | 351 | 352 | fileTopicList = open(os.path.join(module_dir, 'topics.txt'), "r").read().split('\n') 353 | 354 | topicOccurenceSelf = dict(collections.Counter(x for x in selfTopicList if x)) 355 | topicOccurenceContributed = dict(collections.Counter(x for x in contributedTopicList if x)) 356 | topicOccurenceStarred = dict(collections.Counter(x for x in starredTopicList if x)) 357 | 358 | self.topicSkill = topicOccurenceSelf # we are using this to calculate skill points down there 359 | 360 | # topicOccurenceSelf 4 361 | # topicOccurenceContributed 3 362 | # topicOccurenceStarred 1 363 | 364 | def removeIrrelevant(topicDict): 365 | to_delete = set(topicDict.keys()).difference(fileTopicList) # removing A-B from A 366 | for d in to_delete: 367 | del topicDict[d] 368 | 369 | removeIrrelevant(topicOccurenceSelf) 370 | removeIrrelevant(topicOccurenceContributed) 371 | removeIrrelevant(topicOccurenceStarred) 372 | 373 | def updateValue(topicDict): 374 | for topic in topicDict.keys(): 375 | if topic not in self.topicInterestDict.keys(): 376 | value = 0 377 | if topic in topicOccurenceSelf.keys(): 378 | value = value + 4 * topicOccurenceSelf[topic] 379 | if topic in topicOccurenceContributed.keys(): 380 | value = value + 3 * topicOccurenceContributed[topic] 381 | if topic in topicOccurenceStarred.keys(): 382 | value = value + 1 * topicOccurenceStarred[topic] 383 | self.topicInterestDict[topic] = value 384 | 385 | updateValue(topicOccurenceSelf) 386 | updateValue(topicOccurenceContributed) 387 | updateValue(topicOccurenceStarred) 388 | 389 | self.topicInterestDict = dict(sorted(self.topicInterestDict.items(), key=lambda x: x[1], reverse=True)) 390 | 391 | def setSkillPoints(self): 392 | self.topicSkillDict = dict() 393 | 394 | prm_query = """ 395 | { 396 | user(login:""" + '"' + self.username + '"' + """) 397 | { 398 | pullRequests(last: 100, states: MERGED) { 399 | nodes { 400 | repository { 401 | repositoryTopics(first: 100) { 402 | nodes { 403 | topic { 404 | name 405 | } 406 | } 407 | } 408 | } 409 | } 410 | } 411 | issues(last: 100, states: CLOSED) { 412 | nodes { 413 | repository { 414 | repositoryTopics(first: 100) { 415 | nodes { 416 | topic { 417 | name 418 | } 419 | } 420 | } 421 | } 422 | } 423 | } 424 | } 425 | } 426 | """ 427 | 428 | PRtopicList = list() 429 | PRtopicDict = dict() 430 | 431 | issueTopicList = list() 432 | issueTopicDict = dict() 433 | 434 | result = runquery(self.token, prm_query) 435 | if result: 436 | 437 | for i in result["data"]["user"]["pullRequests"]["nodes"]: 438 | for j in i["repository"]["repositoryTopics"]["nodes"]: 439 | PRtopicList.append(j["topic"]["name"]) 440 | 441 | for i in result["data"]["user"]["issues"]["nodes"]: 442 | for j in i["repository"]["repositoryTopics"]["nodes"]: 443 | issueTopicList.append(j["topic"]["name"]) 444 | 445 | PRtopicDict = dict(collections.Counter(x for x in PRtopicList if x)) 446 | issueTopicDict = dict(collections.Counter(x for x in issueTopicList if x)) 447 | 448 | def updateSkillsetValue(topicDict): 449 | for topic in topicDict.keys(): 450 | if topic not in self.topicSkillDict.keys() and topic in self.topicInterestDict.keys(): 451 | value = 0 452 | if topic in PRtopicDict.keys(): 453 | value = value + PRtopicDict[topic] 454 | if topic in issueTopicDict.keys(): 455 | value = value + issueTopicDict[topic] 456 | if topic in self.topicSkill.keys(): 457 | value = value + 0.5 * self.topicSkill[topic] 458 | self.topicSkillDict[topic] = value 459 | 460 | updateSkillsetValue(PRtopicDict) 461 | updateSkillsetValue(issueTopicDict) 462 | updateSkillsetValue(self.topicSkill) 463 | self.topicSkill = dict(sorted(self.topicSkill.items(), key=lambda x: x[1], reverse=True)) 464 | 465 | """ 466 | username = input("Enter the username: ") 467 | user = UserMetrics(username, "") 468 | 469 | print() 470 | print("The Base Score is " + str(user.basePoints)) 471 | print("The Creation Points is " + str(usermetrics.creationPoints)) 472 | print("The Activity Points is " + str(usermetrics.activityPoints)) 473 | print("The Contribution Points is " + str(usermetrics.contributionPoints)) 474 | print() 475 | print("The Topic Interests are \n" + str(usermetrics.topicInterestDict)) 476 | print() 477 | print("The Topic Skill are \n" + str(usermetrics.topicSkillDict)) 478 | print() 479 | print("The User Points is " + str(usermetrics.userPoints)) 480 | """ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------