Skip to content

Commit 9769dfa

Browse files
committed
Made requested changes
1 parent c316477 commit 9769dfa

File tree

2 files changed

+42
-33
lines changed

2 files changed

+42
-33
lines changed

scripts/2-process/github_process.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ def process_totals_by_restriction(args, count_data):
121121

122122
data[key] += count
123123
data = pd.DataFrame(data.items(), columns=["Category", "Count"])
124-
data.sort_values("Count", ascending=True, inplace=True)
124+
data.sort_values("Category", ascending=True, inplace=True)
125125
data.reset_index(drop=True, inplace=True)
126126
file_path = shared.path_join(
127127
PATHS["data_phase"], "github_totals_by_restriction.csv"

scripts/3-report/github_report.py

Lines changed: 41 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
# Setup
2727
LOGGER, PATHS = shared.setup(__file__)
2828
QUARTER = os.path.basename(PATHS["data_quarter"])
29-
SECTION = "GitHub Data"
29+
SECTION = "GitHub Ddta"
3030

3131

3232
def parse_arguments():
@@ -99,23 +99,44 @@ def github_intro(args):
9999
name_label = "TOOL_IDENTIFIER"
100100
data = pd.read_csv(file_path, index_col=name_label)
101101
total_repositories = data.loc["Total public repositories", "COUNT"]
102+
cc_total = data[data.index.str.startswith("CC")]["COUNT"].sum()
103+
cc_percentage = (cc_total / total_repositories) * 100
102104
shared.update_readme(
103105
args,
104106
SECTION,
105107
"Overview",
106108
None,
107109
None,
108-
"GitHub data uses the `total_count` returned by"
109-
" API for search queries of the SPDX IDENTIFIER URLS"
110+
"The GitHub data, below, uses the `total_count`"
111+
" returned by API for search queries of the various legal tools"
112+
"\n"
113+
f"**The results indicate that {cc_total}{cc_percentage}"
114+
" of the {total_repositories} total public repositories"
115+
" on GitHub that use a CC legal tool. ( Additionally,"
116+
" many more use a non-CC use a Public domain"
117+
" equivalent legal tools.**\n"
118+
"\n"
119+
" The Github data showcases the different level of"
120+
" rights reserved on repositories We have Public"
121+
" domain which includes works released under CC0, 0BSD and Unlicense"
122+
" meaning developers have waived all their rights to a software."
123+
" Allowing anyone to freely use, modify, and distribute the code"
124+
" without restriction."
125+
" See more at"
126+
" [Public-domain-equivalent license]"
127+
"(https://en.wikipedia.org/wiki/Public-domain-equivalent_license)"
128+
" While a Permissive category of license contains works"
129+
" under MIT-0 and CC BY 4.0 allows users to"
130+
" reuse the code with some conditions and attribution"
131+
" [Permissive license]"
132+
"(https://en.wikipedia.org/wiki/Permissive_software_license)"
133+
" and Copyleft contains works under CC BY-SA 4.0."
134+
" which requires any derivative works to be licensed"
135+
" under the same terms."
136+
" [Copyleft](https://en.wikipedia.org/wiki/Copyleft)"
110137
"\n"
111-
f"**The results indicate that a total of {total_repositories} "
112-
"repositories on GitHub use a mix of some rights reserved and "
113-
"no rights reserved licenses which showcases the usage of "
114-
"attribution based Creative Commons (CC) legal tool "
115-
"and Public domain equivalent.**\n"
116-
"/n"
117138
"Thank you GitHub for providing public access to"
118-
"repository metadata through its API.",
139+
" repository metadata through its API.",
119140
)
120141

121142

@@ -158,12 +179,12 @@ def plot_totals_by_license_type(args):
158179
title,
159180
image_path,
160181
"Plots showing totals by license type."
161-
"This shows the distribution of different licenses "
162-
"used in GitHub repositories. "
163-
"Allowing Commons to evaluate how freely softwares on "
164-
"GitHub are being used, modified, and shared "
165-
"and how developers choose to share their works. "
166-
"See more at [SPDX License List]"
182+
" This shows the distribution of different CC license"
183+
" and non CC license used in GitHub repositories."
184+
" Allowing Commons to evaluate how freely softwares on"
185+
" GitHub are being used, modified, and shared"
186+
" and how developers choose to share their works."
187+
" See more at [SPDX License List]"
167188
"(https://spdx.org/licenses/)",
168189
)
169190

@@ -206,21 +227,9 @@ def plot_totals_by_restriction(args):
206227
title,
207228
image_path,
208229
"Plots showing totals by different levels of restrictions."
209-
"Public domain includes works released under CC0, 0BSD and Unlicense "
210-
"meaning developers have waived all their rights to a software. "
211-
"Allowing anyone to freely use, modify, and distribute the code "
212-
"without restriction. "
213-
"See more at "
214-
"[Public-domain-equivalent license]"
215-
"(https://en.wikipedia.org/wiki/Public-domain-equivalent_license) "
216-
"While Permissive contains works under MIT-0 and CC BY 4.0 "
217-
"allows users to reuse the code with some conditions and attribution "
218-
"[Permissive license]"
219-
"(https://en.wikipedia.org/wiki/Permissive_software_license) "
220-
"and Copyleft contains works under CC BY-SA 4.0. "
221-
"which requires any derivative works to be licensed "
222-
"under the same terms. "
223-
"[Copyleft](https://en.wikipedia.org/wiki/Copyleft) ",
230+
" This shows the distribution of Public domain,"
231+
" Permissive, and Copyleft"
232+
" licenses used in GitHub repositories.",
224233
)
225234

226235

@@ -237,7 +246,7 @@ def main():
237246
args,
238247
PATHS["repo"],
239248
PATHS["data_quarter"],
240-
f"Add and commit Github reports for {QUARTER}",
249+
f"Add and commit GitHub reports for {QUARTER}",
241250
)
242251
shared.git_push_changes(args, PATHS["repo"])
243252

0 commit comments

Comments
 (0)