├── .gitignore
├── requirements.txt
├── README.md
├── users_info.py
├── export_traffic.py
├── github_metrics.py
└── LICENSE
/.gitignore:
--------------------------------------------------------------------------------
1 | # Member list
2 | memblist*.txt
3 |
4 |
5 | # Other
6 | credentials_google_drive.json
7 | bin/
8 | include/
9 | lib/
10 | output/
11 | pip-selfcheck.json
12 | pyvenv.cfg
13 | WIP/
14 | WIP/**
15 | metrics-env/
16 | metrics-env/**
17 | output/**
18 | update_gsheet.py
19 | *.csv
--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | absl-py==0.12.0
2 | appnope==0.1.2
3 | argon2-cffi==20.1.0
4 | arrow==0.14.7
5 | astunparse==1.6.3
6 | async-generator==1.10
7 | attrs==20.3.0
8 | backcall==0.2.0
9 | bleach==3.3.0
10 | cachetools==4.2.1
11 | certifi==2019.11.28
12 | cffi==1.14.5
13 | chardet==3.0.4
14 | cryptography==3.4.7
15 | decorator==5.0.7
16 | defusedxml==0.7.1
17 | entrypoints==0.3
18 | flatbuffers==1.12
19 | gast==0.4.0
20 | google-api-python-client==1.7.11
21 | google-auth==1.29.0
22 | google-auth-httplib2==0.0.3
23 | google-auth-oauthlib==0.4.1
24 | google-pasta==0.2.0
25 | grpcio==1.34.1
26 | h5py==3.1.0
27 | httplib2==0.19.1
28 | ics==0.7
29 | idna==2.8
30 | ipykernel==5.5.3
31 | ipython==7.22.0
32 | ipython-genutils==0.2.0
33 | jedi==0.18.0
34 | Jinja2==2.11.3
35 | jsonschema==3.2.0
36 | jupyter-client==6.1.12
37 | jupyter-core==4.7.1
38 | jupyterlab-pygments==0.1.2
39 | keras-nightly==2.5.0.dev2021032900
40 | Keras-Preprocessing==1.1.2
41 | Markdown==3.3.4
42 | MarkupSafe==1.1.1
43 | mistune==0.8.4
44 | nbclient==0.5.3
45 | nbconvert==6.0.7
46 | nbformat==5.1.3
47 | nest-asyncio==1.5.1
48 | notebook==6.3.0
49 | numpy==1.19.5
50 | oauthlib==3.1.0
51 | opt-einsum==3.3.0
52 | packaging==20.9
53 | pandocfilters==1.4.3
54 | parso==0.8.2
55 | pexpect==4.8.0
56 | pickleshare==0.7.5
57 | Pillow==8.2.0
58 | prometheus-client==0.10.1
59 | prompt-toolkit==3.0.18
60 | protobuf==3.15.8
61 | ptyprocess==0.7.0
62 | pyasn1==0.4.8
63 | pyasn1-modules==0.2.8
64 | pycparser==2.20
65 | Pygments==2.8.1
66 | pyparsing==2.4.7
67 | pyrsistent==0.17.3
68 | python-dateutil==2.8.1
69 | PyYAML==5.4.1
70 | pyzmq==22.0.3
71 | requests==2.22.0
72 | requests-oauthlib==1.3.0
73 | rsa==4.7.2
74 | Send2Trash==1.5.0
75 | six==1.15.0
76 | TatSu==5.6.1
77 | tensorboard==2.5.0
78 | tensorboard-data-server==0.6.0
79 | tensorboard-plugin-wit==1.8.0
80 | tensorflow==2.5.0rc1
81 | tensorflow-estimator==2.5.0rc0
82 | termcolor==1.1.0
83 | terminado==0.9.4
84 | testpath==0.4.4
85 | tornado==6.1
86 | traitlets==5.0.5
87 | typing-extensions==3.7.4.3
88 | uritemplate==3.0.1
89 | urllib3==1.25.8
90 | wcwidth==0.2.5
91 | webencodings==0.5.1
92 | Werkzeug==1.0.1
93 | wrapt==1.12.1
94 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # GitHub Metrics
2 |
3 | **Notice:** `urllib` already migrated to `requests` library.
4 |
5 | ## Step 1 - Intro
6 |
7 | I created this repo to gather some metrics for the company I used to work.
8 | Its purpose is to collect metrics around an organization repositories, such as commits, forks, stars etc.
9 |
10 | I used [GitHub’s REST API v3](https://developer.github.com/v3/) and [PyGitHub](http://pygithub.readthedocs.io) to develop the Python scripts.
11 |
12 | In order to be able to run this project you have to
13 |
14 | 1) be a member of the organization you want to collect the metrics from
15 | 2) have a Github personal token (generate here: https://github.com/settings/tokens)
16 |
17 | ## Step 0 - Installing requirements
18 |
19 | 1. Clone this repo
20 | 2. Create a virtual environment (I use [`venv`](https://docs.python.org/3/library/venv.html))
21 | 3. Activate your environment: `$ source [ENVIRONMENT_NAME]/bin/activate`
22 | 4. Install dependencies: `$ pip install -r requirements.txt`
23 |
24 | ## Using the repo
25 |
26 | There are 2 Python scripts. Their usage and purposes are described below.
27 |
28 | ### FIRST SCRIPT
29 |
30 | You execute the file on command line (terminal, bash, whatever you name it) by typing:
31 | ```
32 | $ python github_metrics.py -t [GITHUB-TOKEN] -o [ORGANIZATION NAME]
33 | ```
34 |
35 | And `github_metrics.py` script runs the functions:
36 |
37 | **1) `list_orgs(token)`**
38 |
39 | function that returns a list of the organizations the user belongs to.
40 |
41 | **2) `list_org_members(org, token)`**
42 |
43 | function that builds a list with the members of an organization inside GitHub. Only current members are listed. It returns one list with members names and other list with members logins (usernames).
44 |
45 | **3) `export_code_frequency(directory, org, token)`**
46 |
47 | function that gather statistics for all repositories in an organization, by week/user/repo, and returns a csv file with: name of the repository, week in question, number of additions, number of deletions, author of such commit and if the author is a member or not of the organization.
48 |
49 | **4) `list_unique_collaborators(directory, org, token)`**
50 |
51 | function that returns the number of unique collaborators of an organization (for all its repos), with the information if the collaborator is a member of the organization or not.
52 |
53 | **5) `export_community_engagement(directory, org, token)`**
54 |
55 | function that gather basic metrics for all repos of an organization, such as number of forks, stars, commits and collaborators. The function returns a csv file with these informations for each repo.
56 |
57 | ### SECOND SCRIPT
58 |
59 | You execute the file on command line by typing:
60 | ```
61 | $ python export_traffic.py -t [GITHUB-TOKEN] -o [ORGANIZATION NAME]
62 | ```
63 |
64 | And `export_traffic.py` runs the functions:
65 |
66 | **1) `test_push_access(org, token)`**
67 |
68 | function that will check which repositories your token has push access to, inside the specified organization. It returns two lists: one with the repositories that the token doesn't have push access to, and other with the repos the token has access to.
69 |
70 | **2) `export_traffic(directory, org, repos_ok, token)`**
71 |
72 | function that exports the traffic from GitHub repos that your token has push access to, for the last 14 days. It will create a csv file for the following metrics: traffic (views), clones, paths and referrers. Please check [further documentation](https://developer.github.com/v3/repos/traffic/) from GitHub.
73 |
74 | **3) `relevantrepos_noaccess(numstars, repos_noaccess, organization, authToken)`**
75 |
76 | function that checks which repositories over `numstars` your token doesn't have access to, and returns a dictionary with the name of the repo and its number of stars.
77 |
--------------------------------------------------------------------------------
/users_info.py:
--------------------------------------------------------------------------------
1 | import argparse
2 | from github import Github
3 | import requests
4 | import json
5 | import csv
6 | import os
7 | import datetime
8 |
9 | s = requests.Session()
10 |
11 | import time
12 |
13 | now = time.time()
14 | today = datetime.date.today()
15 | todaystr = str(today).replace("-", "")
16 |
17 |
18 | def list_org_members(org, authToken):
19 | s = requests.Session()
20 | s.headers.update({'Authorization': 'token ' + authToken})
21 | g = Github(authToken)
22 | namesmembers = []
23 | try:
24 | filename = "memblist_" + org + ".txt"
25 | text_file = open(filename, "r")
26 | loginmembers = text_file.read().split(',')
27 | except:
28 | loginmembers = []
29 | for orgs in g.get_user().get_orgs():
30 | if orgs.login == org:
31 | for memb in orgs.get_members():
32 | if memb.login not in loginmembers:
33 | loginmembers.append(memb.login)
34 | else:
35 | next
36 | if loginmembers[0] == "":
37 | loginmembers.pop(0)
38 | for member in loginmembers:
39 | r = s.get("https://api.github.com/users/" + member)
40 | r_user = json.loads(r.text)
41 | try:
42 | if r_user["name"] != None:
43 | namesmembers.append(r_user["name"])
44 | else:
45 | namesmembers.append(r_user["login"])
46 | except:
47 | next
48 | return loginmembers, namesmembers
49 |
50 |
51 | def get_rate_limit(authToken):
52 | g = Github(authToken)
53 | ratelimit = g.rate_limiting
54 | remaining = ratelimit[0]
55 | reset_time = g.rate_limiting_resettime
56 | minutes_left = (reset_time - now) / 60
57 | if remaining == 0:
58 | print(minutes_left)
59 | return remaining
60 |
61 |
62 | def get_users_info(members_list, authToken):
63 | g = Github(authToken)
64 | s.headers.update({'Authorization': 'token ' + authToken})
65 | orgs = g.get_user().get_orgs()
66 | with open("github_users_info_" + todaystr + ".csv", 'w', encoding='utf-8') as csvfile:
67 | csvwriter = csv.writer(csvfile, delimiter=',')
68 | csvwriter.writerow(
69 | ['Organization', 'Repo', 'Name', 'Username', 'Email', 'Date interaction', 'Type interaction'])
70 | for org in orgs:
71 | org_name = org.name
72 | org_login = org.login
73 | print("\n~~~~~~~~~~~~~~~~~~~~~~~~~~~ ", org_name, " ~~~~~~~~~~~~~~~~~~~~~~~~~~~")
74 | repos = org.get_repos()
75 | totalrepos = 0
76 | repocount = 0
77 | for repo in repos:
78 | if repo.fork == False:
79 | totalrepos += 1
80 | for i, repo in enumerate(repos):
81 | if repo.fork == False:
82 | repo_name = repo.name
83 | repocount += 1
84 | print("\n--> Repo [", repocount, "/", totalrepos, "] :", repo_name)
85 | count = 0
86 | forks = repo.get_forks()
87 | for fork in forks:
88 | forker_login = fork.owner.login
89 | forker_name = fork.owner.name
90 | forker_email = fork.owner.email
91 | forker_date = fork.created_at
92 | forker_date = forker_date.date()
93 | if forker_login not in members_list and forker_email != None:
94 | count += 1
95 | print("fork //", forker_email, "//", forker_date)
96 | csvwriter.writerow(
97 | [org_login, repo_name, forker_name, forker_login, forker_email, forker_date, "fork"])
98 | stargazers = repo.get_stargazers_with_dates()
99 | for stargazer in stargazers:
100 | stargazer_name = stargazer.user.name
101 | stargazer_login = stargazer.user.login
102 | stargazer_email = stargazer.user.email
103 | stargazer_date = stargazer.starred_at
104 | stargazer_date = stargazer_date.date()
105 | if stargazer_login not in members_list and stargazer_email != None:
106 | count += 1
107 | print("star //", stargazer_email, "//", stargazer_date)
108 | csvwriter.writerow(
109 | [org_login, repo_name, stargazer_name, stargazer_login, stargazer_email, stargazer_date,
110 | "star"])
111 | try:
112 | stats = repo.get_stats_contributors()
113 | for stat in stats:
114 | weeks_list = []
115 | for week in stat.weeks:
116 | if week.c != 0:
117 | weeks_list.append(week.w)
118 | commiter_date = weeks_list[-1]
119 | commiter_date = commiter_date.date()
120 | commiter_login = str(stat.author)
121 | commiter_login = (commiter_login.replace('NamedUser(login="', "")).replace('")', "")
122 | if commiter_login not in members_list:
123 | r = s.get("https://api.github.com/users/" + commiter_login)
124 | r_user = json.loads(r.text)
125 | commiter_email = r_user['email']
126 | commiter_name = r_user['name']
127 | if commiter_email != None:
128 | count += 1
129 | print("commit //", commiter_email, "//", commiter_date)
130 | csvwriter.writerow(
131 | [org_login, repo_name, commiter_name, commiter_login, commiter_email,
132 | commiter_date,
133 | "commit"])
134 | except TypeError as e:
135 | print(e)
136 | next
137 |
138 |
139 | currenttoken = input("Type your Github token: ")
140 |
141 | remaining_limit = get_rate_limit(currenttoken)
142 |
143 | if remaining_limit > 0:
144 | members_login, members_name = list_org_members("src-d", currenttoken)
145 | users_commited = get_users_info(members_login, currenttoken)
146 | elif remaining_limit == 0:
147 | print("rate limit exceeded")
148 |
--------------------------------------------------------------------------------
/export_traffic.py:
--------------------------------------------------------------------------------
1 | import argparse
2 | import requests
3 | import json
4 | from github import Github
5 | import csv
6 | from datetime import date, timedelta
7 | import os
8 | import numpy as np
9 | import pandas as pd
10 |
11 |
12 | end_date = date.today() - timedelta(days=1)
13 | start_date = end_date - timedelta(days=14)
14 | today = str(date.today())
15 | today = today.replace("-", "")
16 |
17 | def setup():
18 | parser = argparse.ArgumentParser()
19 | parser.add_argument("-o", "--org", help="choose what company you what to see", required=True)
20 | parser.add_argument("-t", "--token", help="OAuth token from GitHub", required=True)
21 | args = parser.parse_args()
22 | return args
23 |
24 | def test_push_access(organization, authToken):
25 | s = requests.Session()
26 | s.headers.update({'Authorization': 'token ' + authToken})
27 | g = Github(authToken)
28 | repos_ok = []
29 | repos_noaccess = []
30 | allorgs = g.get_user().get_orgs()
31 | for orgs in allorgs:
32 | if orgs.login == organization:
33 | print("Checking push access for", orgs.name, "repositories. \n")
34 | for repo in orgs.get_repos():
35 | if repo.fork == False and repo.private == False:
36 | currentrepo = repo.name
37 | r = s.get("https://api.github.com/repos/" + organization + "/" + currentrepo + "/traffic/views")
38 | r_views = json.loads(r.text)
39 | try:
40 | if r_views["message"] == "Must have push access to repository":
41 | repos_noaccess.append(currentrepo)
42 | except:
43 | repos_ok.append(currentrepo)
44 | return repos_noaccess, repos_ok
45 |
46 |
47 | def relevantrepos_noaccess(numstars, repos_noaccess, organization, authToken):
48 | g = Github(authToken)
49 | repos_dict = {}
50 | allorgs = g.get_user().get_orgs()
51 | for orgs in allorgs:
52 | if orgs.login == organization:
53 | for repo in orgs.get_repos():
54 | reponame = repo.name
55 | stars = repo.stargazers_count
56 | if reponame in repos_noaccess and stars >= numstars:
57 | repos_dict[reponame] = stars
58 | return repos_dict
59 |
60 |
61 | def export_traffic(directory, organization, repos_ok, authtoken):
62 | s = requests.Session()
63 | s.headers.update({'Authorization': 'token ' + authtoken})
64 | g = Github(authtoken)
65 | reposlist = []
66 | allrepos = g.get_user().get_repos()
67 |
68 | print("Collecting traffic data from", organization, "repositories. \n")
69 |
70 | for repo in allrepos:
71 | repo_owner = str(repo.owner)
72 | repo_owner = (repo_owner.replace('NamedUser(login="', "")).replace('")', "")
73 | if repo.fork == False and repo.private == False and repo_owner == organization and repo.name in repos_ok:
74 | reposlist.append(repo.name)
75 |
76 | count=0
77 | countrow = 0
78 | views_array = np.zeros(((len(repos_ok) * 15), 5), dtype=np.object_)
79 | views_array[0, 0] = "Org"
80 | views_array[0, 1] = "Repo"
81 | views_array[0, 2] = "Date"
82 | views_array[0, 3] = "Views count"
83 | views_array[0, 4] = "Views unique"
84 | print("\n======================= VIEWS =======================")
85 | for i in reposlist:
86 | count+=1
87 | print("[", str(count).zfill(2), "|", len(repos_ok), "] views for", i)
88 | r_views = s.get("https://api.github.com/repos/" + organization + "/" + i + "/traffic/views")
89 | r_views = json.loads(r_views.text)
90 | for date in r_views["views"]:
91 | countrow += 1
92 | fixeddate = str(date["timestamp"]).replace("T00:00:00Z", "")
93 | views_array[countrow, 0] = organization
94 | views_array[countrow, 1] = i
95 | views_array[countrow, 2] = fixeddate
96 | views_array[countrow, 3] = date["count"]
97 | views_array[countrow, 4] = date["uniques"]
98 | df = pd.DataFrame(views_array[1:], columns=views_array[0])
99 | df = df[(df.T != 0).any()]
100 | df['Date'] = pd.to_datetime(df.Date)
101 | sorteddf = df.sort_values(['Date', 'Repo'])
102 | sorteddf.to_csv(directory + "/github_views_" + organization + "_" + today + ".csv", sep=',', encoding='utf-8', index=False)
103 |
104 | count=0
105 | countrow = 0
106 | clones_array = np.zeros(((len(repos_ok) * 15), 5), dtype=np.object_)
107 | clones_array[0, 0] = "Org"
108 | clones_array[0, 1] = "Repo"
109 | clones_array[0, 2] = "Date"
110 | clones_array[0, 3] = "Clones count"
111 | clones_array[0, 4] = "Clones unique"
112 | print("\n======================= CLONES ======================")
113 | for i in reposlist:
114 | count += 1
115 | print("[", str(count).zfill(2), "|", len(repos_ok), "] clones for", i)
116 | r_clones = s.get("https://api.github.com/repos/" + organization + "/" + i + "/traffic/clones")
117 | r_clones = json.loads(r_clones.text)
118 | for date in r_clones["clones"]:
119 | countrow += 1
120 | fixeddate = str(date["timestamp"]).replace("T00:00:00Z", "")
121 | clones_array[countrow, 0] = organization
122 | clones_array[countrow, 1] = i
123 | clones_array[countrow, 2] = fixeddate
124 | clones_array[countrow, 3] = date["count"]
125 | clones_array[countrow, 4] = date["uniques"]
126 | df = pd.DataFrame(clones_array[1:], columns=clones_array[0])
127 | df = df[(df.T != 0).any()]
128 | df['Date'] = pd.to_datetime(df.Date)
129 | sorteddf = df.sort_values(['Date', 'Repo'])
130 | sorteddf.to_csv(directory + "/github_clones_" + organization + "_" + today + ".csv", sep=',', encoding='utf-8', index=False)
131 |
132 |
133 | count=0
134 | countrow = 0
135 | paths_array = np.zeros(((len(repos_ok) * 10), 8), dtype=np.object_)
136 | paths_array[0, 0] = "Start date"
137 | paths_array[0, 1] = "End date"
138 | paths_array[0, 2] = "Org"
139 | paths_array[0, 3] = "Repo"
140 | paths_array[0, 4] = "Path"
141 | paths_array[0, 5] = "Title"
142 | paths_array[0, 6] = "Count"
143 | paths_array[0, 7] = "Unique"
144 | with open(directory + "/github_paths_" + organization + "_" + today + ".csv", 'w', encoding='utf-8') as csvfile:
145 | csvwriter = csv.writer(csvfile, delimiter=',')
146 | csvwriter.writerow(
147 | ["start date", "end date", "repo", "path", "title", "count", "uniques"])
148 | print("\n======================= PATHS =======================")
149 | for i in reposlist:
150 | count +=1
151 | print("[", str(count).zfill(2), "|", len(repos_ok), "] paths for", i)
152 | r_paths = s.get("https://api.github.com/repos/" + organization + "/" + i + "/traffic/popular/paths")
153 | r_paths = json.loads(r_paths.text)
154 | for path in r_paths:
155 | countrow += 1
156 | paths_array[countrow, 0] = start_date
157 | paths_array[countrow, 1] = end_date
158 | paths_array[countrow, 2] = organization
159 | paths_array[countrow, 3] = i
160 | paths_array[countrow, 4] = path["path"]
161 | paths_array[countrow, 5] = path["title"]
162 | paths_array[countrow, 6] = path["count"]
163 | paths_array[countrow, 7] = path["uniques"]
164 | df = pd.DataFrame(paths_array[1:], columns=paths_array[0])
165 | df = df[(df.T != 0).any()]
166 | df.to_csv(directory + "/github_paths_" + organization + "_" + today + ".csv", sep=',', encoding='utf-8', index=False)
167 |
168 |
169 | count=0
170 | countrow = 0
171 | referrers_array = np.zeros(((len(repos_ok) * 10), 7), dtype=np.object_)
172 | referrers_array[0, 0] = "Start date"
173 | referrers_array[0, 1] = "End date"
174 | referrers_array[0, 2] = "Org"
175 | referrers_array[0, 3] = "Repo"
176 | referrers_array[0, 4] = "Referrer"
177 | referrers_array[0, 5] = "Count"
178 | referrers_array[0, 6] = "Unique"
179 | print("\n======================= REFERRERS ===================")
180 | for i in reposlist:
181 | count+=1
182 | print("[", str(count).zfill(2), "|", len(repos_ok), "] referrers for", i)
183 | r_referrers = s.get("https://api.github.com/repos/" + organization + "/" + i + "/traffic/popular/referrers")
184 | r_referrers = json.loads(r_referrers.text)
185 | for reff in r_referrers:
186 | countrow += 1
187 | referrers_array[countrow, 0] = start_date
188 | referrers_array[countrow, 1] = end_date
189 | referrers_array[countrow, 2] = organization
190 | referrers_array[countrow, 3] = i
191 | referrers_array[countrow, 4] = reff["referrer"]
192 | referrers_array[countrow, 5] = reff["count"]
193 | referrers_array[countrow, 6] = reff["uniques"]
194 | df = pd.DataFrame(referrers_array[1:], columns=referrers_array[0])
195 | df = df[(df.T != 0).any()]
196 | df.to_csv(directory + "/github_referrers_" + organization + "_" + today + ".csv", sep=',', encoding='utf-8', index=False)
197 |
198 | def main():
199 | args = setup()
200 | organization = args.org
201 | authToken = args.token
202 | s = requests.Session()
203 | s.headers.update({'Authorization': 'token ' + authToken})
204 | g = Github(authToken)
205 | directory = "output/" + organization
206 | if not os.path.exists(directory):
207 | os.makedirs(directory)
208 | try:
209 | ratelimit = g.rate_limiting
210 | print("Valid token. Starting process. \n")
211 | repos_noaccess, repos_ok = test_push_access(organization, authToken)
212 | print("Repos without push access: ", repos_noaccess, "\n")
213 | print("Repos ok: ", repos_ok, "\n")
214 | print("")
215 | export_traffic(directory, organization, repos_ok, authToken)
216 | print("")
217 | print("Repos with over 25 stars without push access:")
218 | print(relevantrepos_noaccess(25, repos_noaccess, organization, authToken))
219 |
220 | except:
221 | print("Could not complete tasks.")
222 |
223 |
224 |
225 | if __name__ == '__main__':
226 | main()
227 |
--------------------------------------------------------------------------------
/github_metrics.py:
--------------------------------------------------------------------------------
1 | import argparse
2 | from github import Github
3 | import requests
4 | import json
5 | import csv
6 | import os
7 | import datetime
8 | import socket
9 | import pandas as pd
10 |
11 | socket.setdefaulttimeout(60 * 60)
12 | today = datetime.date.today()
13 | todaystr = str(today)
14 |
15 | def setup():
16 | parser = argparse.ArgumentParser()
17 | parser.add_argument("-o", "--org", help="choose what company you what to see", required=True)
18 | parser.add_argument("-t", "--token", help="OAuth token from GitHub", required=True)
19 | args = parser.parse_args()
20 | return args
21 |
22 | def list_orgs(authToken):
23 | g = Github(authToken)
24 | orgslist = []
25 | for orgs in g.get_user().get_orgs():
26 | orgslist.append(orgs.login)
27 | return orgslist
28 |
29 | def list_org_members(org, authToken):
30 | s = requests.Session()
31 | s.headers.update({'Authorization': 'token ' + authToken})
32 | g = Github(authToken)
33 | namesmembers = []
34 | try:
35 | filename = "memblist_" + org + ".txt"
36 | text_file = open(filename, "r")
37 | loginmembers = text_file.read().split(',')
38 | except:
39 | loginmembers = []
40 | for orgs in g.get_user().get_orgs():
41 | if orgs.login == org:
42 | for memb in orgs.get_members():
43 | if memb.login not in loginmembers:
44 | loginmembers.append(memb.login)
45 | else:
46 | next
47 | if loginmembers[0] == "":
48 | loginmembers.pop(0)
49 | for member in loginmembers:
50 | r = s.get("https://api.github.com/users/" + member)
51 | r_user = json.loads(r.text)
52 | try:
53 | if r_user["name"] != None:
54 | namesmembers.append(r_user["name"])
55 | else:
56 | namesmembers.append(r_user["login"])
57 | except:
58 | next
59 | return loginmembers, namesmembers
60 |
61 | def export_code_frequency(directory, organization, authToken):
62 | totalrepos = 0
63 | g = Github(authToken)
64 | today = str(datetime.date.today())
65 | today = today.replace("-", "")
66 | allorgs = g.get_user().get_orgs()
67 | for orgs in allorgs:
68 | if orgs.login == organization:
69 | for repo in orgs.get_repos():
70 | if repo.fork == False and repo.private == False:
71 | totalrepos +=1
72 | with open(directory + "/github_code_frequency_" + organization + "_" + today+ ".csv", 'w', encoding='utf-8') as csvfile:
73 | csvwriter = csv.writer(csvfile, delimiter=',')
74 | csvwriter.writerow(
75 | ["count", "org", "repo", "week", "additions", "deletions", "commits", "author", "is a member"])
76 | loginmembers, namesmembers = list_org_members(organization, authToken)
77 | for orgs in allorgs:
78 | if orgs.login == organization:
79 | print("Gathering code frequency for all repos on", orgs.login)
80 | count = 0
81 | for repo in orgs.get_repos():
82 | controws = 0
83 | if repo.fork == False and repo.private == False:
84 | count += 1
85 | reponame = repo.name
86 | try:
87 | stats = repo.get_stats_contributors()
88 | for stat in stats:
89 | author = str(stat.author)
90 | author = (author.replace('NamedUser(login="', "")).replace('")', "")
91 | for week in stat.weeks:
92 | if week.c != 0:
93 | date = str(week.w)
94 | date = date[:10]
95 | if author in loginmembers:
96 | controws+=1
97 | try:
98 | csvwriter.writerow(
99 | [count, orgs.login, reponame, date, week.a, week.d, week.c, author,
100 | "yes"])
101 | except:
102 | print("error")
103 | else:
104 | controws += 1
105 | try:
106 | csvwriter.writerow(
107 | [count, orgs.login, reponame, date, week.a, week.d, week.c, author,
108 | "no"])
109 | except:
110 | print("error2")
111 | print("[", str(count).zfill(2), "|", totalrepos, "] ", orgs.login, " | ", repo.name, " | ", controws, " rows in the file")
112 | except:
113 | print("[", str(count).zfill(2), "|", totalrepos, "] ", orgs.login, " | ", repo.name, "| none")
114 | csvwriter.writerow([count, orgs.login, reponame, 0, 0, 0, 0, 0, "n/a"])
115 | else:
116 | next
117 |
118 | def export_community_engagement(directory, organization, authToken):
119 | g = Github(authToken)
120 | today = str(datetime.date.today())
121 | today = today.replace("-", "")
122 | totalrepos = 0
123 | allorgs = g.get_user().get_orgs()
124 | for orgs in allorgs:
125 | if orgs.login == organization:
126 | for repo in orgs.get_repos():
127 | if repo.fork == False and repo.private == False:
128 | totalrepos += 1
129 | with open(directory + "/github_community_engagement_" + organization + "_" + today+ ".csv", 'w', encoding='utf-8') as csvfile:
130 | csvwriter = csv.writer(csvfile, delimiter=',')
131 | csvwriter.writerow(
132 | ["date", "org", "repo", "forks", "stars", "commits", "collaborators"])
133 | for orgs in allorgs:
134 | if orgs.login == organization:
135 | print("Gathering community metrics for", orgs.login)
136 | count = 0
137 | for repo in orgs.get_repos():
138 | try:
139 | hascommits = repo.get_commits()[0]
140 | except:
141 | hascommits = False
142 | print(repo.name, 'is empty')
143 | countcommit = 0
144 | countcollab = 0
145 | if repo.fork == False and repo.private == False and hascommits != False:
146 | count += 1
147 | for commits in repo.get_commits():
148 | countcommit += 1
149 | for collab in repo.get_contributors():
150 | countcollab += 1
151 | print("[", str(count).zfill(2), "|", totalrepos, "]", repo.name, "|", countcommit, "commits |", repo.forks_count, "forks |",
152 | repo.stargazers_count, "stars |", countcollab, "contributors")
153 | csvwriter.writerow(
154 | [todaystr, organization, repo.name, repo.forks_count, repo.stargazers_count, countcommit,
155 | countcollab])
156 |
157 | def list_unique_collaborators(directory, organization, authToken):
158 | g = Github(authToken)
159 | with open(directory + "/github_unique_collaborators_" + organization + ".csv", "w", encoding="utf-8") as csvfile:
160 | csvwriter = csv.writer(csvfile, delimiter=',')
161 | csvwriter.writerow(["name", "login", "name", "member of the org?"])
162 | loginmembers, namesmembers = list_org_members(organization, authToken)
163 | userslist = []
164 | nameslist = []
165 | allorgs = g.get_user().get_orgs()
166 | for orgs in allorgs:
167 | if orgs.login == organization:
168 | print("Gathering unique collaborators for", orgs.login)
169 | count = 0
170 | for repo in orgs.get_repos():
171 | if repo.fork == False and repo.private == False:
172 | for collab in repo.get_contributors():
173 | if collab.login not in userslist:
174 | userslist.append(collab.login)
175 | if collab.name != None:
176 | nameslist.append(collab.name)
177 | else:
178 | nameslist.append(collab.login)
179 | count += 1
180 | collablogin = collab.login
181 | if collab.name == None:
182 | collabname = collab.login
183 | else:
184 | collabname = collab.name
185 | if collablogin in loginmembers:
186 | member = "yes"
187 | else:
188 | member = "no"
189 | print(str(count).zfill(2), "|", member, "|", collablogin, "|", collabname)
190 | csvwriter.writerow([count, collablogin, collabname, member])
191 |
192 | def main():
193 | args = setup()
194 | organization = args.org
195 | authToken = args.token
196 | g = Github(authToken)
197 | directory = "output/" + organization
198 | if not os.path.exists(directory):
199 | os.makedirs(directory)
200 |
201 | try:
202 | print("Valid token. Starting process. \n")
203 | list_org_members(organization, authToken)
204 | print("")
205 | export_code_frequency(directory, organization, authToken)
206 | print("")
207 | export_community_engagement(directory, organization, authToken)
208 | except Exception as e:
209 | print(e)
210 |
211 |
212 | if __name__ == '__main__':
213 | main()
--------------------------------------------------------------------------------
/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 |
--------------------------------------------------------------------------------