Skip to content

Clean-up reports wording and formatting #296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TimidRobot merged 4 commits into from
Jun 8, 2026
+92 −107
Merged

Clean-up reports wording and formatting #296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8ac9aff
improve description, naming, and wording
TimidRobot Jun 8, 2026
47f2420
improve description and wording
TimidRobot Jun 8, 2026
ab0e62b
improve description and wording
TimidRobot Jun 8, 2026
b4a1c21
improve description and wording
TimidRobot Jun 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 23 additions & 24 deletions scripts/3-report/gcs_report.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ def gcs_intro(args):

def plot_products(args):
"""
Create plots for CC legal tool product totals and percentages
Create a plot for CC legal tool product totals and percentages
"""
LOGGER.info(plot_products.__doc__.strip())
file_path = shared.path_join(
Expand Down Expand Up @@ -152,14 +152,14 @@ def plot_products(args):
SECTION_TITLE,
title,
image_path,
"Plots showing Creative Commons (CC) legal tool product totals and"
"The plot shows Creative Commons (CC) legal tool product totals and"
" percentages.",
)


def plot_tool_status(args):
"""
Create plots for the CC legal tool status totals and percentages
Create a plot for the CC legal tool status totals and percentages
"""
LOGGER.info(plot_tool_status.__doc__.strip())
file_path = shared.path_join(
Expand Down Expand Up @@ -196,14 +196,14 @@ def plot_tool_status(args):
SECTION_TITLE,
title,
image_path,
"Plots showing Creative Commons (CC) legal tool status totals and"
"The plot shows Creative Commons (CC) legal tool status totals and"
" percentages.",
)


def plot_latest_tools(args):
"""
Create plots for latest CC legal tool totals and percentages
Create a plot for latest CC legal tool totals and percentages
"""
LOGGER.info(plot_latest_tools.__doc__.strip())
file_path = shared.path_join(
Expand Down Expand Up @@ -240,14 +240,14 @@ def plot_latest_tools(args):
SECTION_TITLE,
title,
image_path,
"Plots showing latest Creative Commons (CC) legal tool totals and"
"The plot shows the latest Creative Commons (CC) legal tool totals and"
" percentages.",
)


def plot_prior_tools(args):
"""
Create plots for prior CC legal tool totals and percentages
Create a plot for prior CC legal tool totals and percentages
"""
LOGGER.info(plot_prior_tools.__doc__.strip())
file_path = shared.path_join(
Expand Down Expand Up @@ -283,16 +283,15 @@ def plot_prior_tools(args):
SECTION_TITLE,
title,
image_path,
"Plots showing prior Creative Commons (CC) legal tool totals and"
" percentages.",
"The unit names have been normalized (~~`CC BY-ND-NC`~~ =>"
" `CC BY-NC-ND`).",
"The plot shows prior Creative Commons (CC) legal tool totals and"
" percentages. The unit names have been normalized (~~`CC BY-ND-NC`~~"
" => `CC BY-NC-ND`).",
)


def plot_retired_tools(args):
"""
Create plots for retired CC legal tool totals and percentages
Create a plot for retired CC legal tool totals and percentages
"""
LOGGER.info(plot_retired_tools.__doc__.strip())
file_path = shared.path_join(
Expand Down Expand Up @@ -330,16 +329,16 @@ def plot_retired_tools(args):
SECTION_TITLE,
title,
image_path,
"Plots showing retired Creative Commons (CC) legal tools total and"
" percentages.",
"For more information on retired legal tools, see [Retired Legal Tools"
" - Creative Commons](https://creativecommons.org/retiredlicenses/).",
"The plot shows retired Creative Commons (CC) legal tools total and"
" percentages. For more information on retired legal tools, see"
" [Retired Legal Tools - Creative Commons]"
"(https://creativecommons.org/retiredlicenses/).",
)


def plot_countries_highest_usage(args):
"""
Create plots for the countries with highest usage of latest tools
Create a plot for the countries with highest usage of latest tools
"""
LOGGER.info(plot_countries_highest_usage.__doc__.strip())
file_path = shared.path_join(
Expand Down Expand Up @@ -380,20 +379,20 @@ def plot_countries_highest_usage(args):
SECTION_TITLE,
title,
image_path,
"Plots showing countries with the highest useage of the latest"
"The plot shows countries with the highest useage of the latest"
" Creative Commons (CC) legal tools.",
"The latest tools include Licenses version 4.0 (CC BY 4.0, CC BY-NC"
" 4.0, CC BY-NC-ND 4.0, CC BY-NC-SA 4.0, CC-BY-ND 4.0, CC BY-SA 4.0),"
" CC0 1.0, and the Public Domain Mark (PDM 1.0).\n"
"\n"
f"The complete data set indicates there are a total of {total_count}"
" online works using a latest CC legal tool.",
" online works using one of the latest CC legal tools.",
)


def plot_languages_highest_usage(args):
"""
Create plots for the languages with highest usage of latest tools
Create a plot for the languages with highest usage of latest tools
"""
LOGGER.info(plot_languages_highest_usage.__doc__.strip())
file_path = shared.path_join(
Expand Down Expand Up @@ -434,20 +433,20 @@ def plot_languages_highest_usage(args):
SECTION_TITLE,
title,
image_path,
"Plots showing languages with the highest useage of the latest"
"The plot shows the languages with the highest useage of the latest"
" Creative Commons (CC) legal tools.",
"The latest tools include Licenses version 4.0 (CC BY 4.0, CC BY-NC"
" 4.0, CC BY-NC-ND 4.0, CC BY-NC-SA 4.0, CC-BY-ND 4.0, CC BY-SA 4.0),"
" CC0 1.0, and the Public Domain Mark (PDM 1.0).\n"
"\n"
f"The complete data set indicates there are a total of {total_count}"
" online works using a latest CC legal tool.",
" online works using one of the latest CC legal tools.",
)


def plot_free_culture(args):
"""
Create plots for the languages with highest usage of latest tools
Create a plot for the languages with highest usage of latest tools
"""
LOGGER.info(plot_free_culture.__doc__.strip())
file_path = shared.path_join(
Expand Down Expand Up @@ -482,7 +481,7 @@ def plot_free_culture(args):
SECTION_TITLE,
title,
image_path,
"Plots showing Approved for Free Cultural Works legal tool usage.",
"The plot shows Approved for Free Cultural Works legal tool usage.",
"[Understanding Free Cultural Works - Creative"
" Commons](https://creativecommons.org/public-domain/freeworks/):\n"
"\n"
Expand Down
82 changes: 37 additions & 45 deletions scripts/3-report/github_report.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,44 +114,41 @@ def github_intro(args):
"Overview",
None,
None,
"The GitHub data, below, uses the `total_count`"
" returned by API for search queries of the various legal tools."
"The GitHub data, below, uses the `total_count` returned by the API"
" for search queries of the various legal tools.\n"
"\n"
f"**The results indicate that {cc_total} ({cc_percentage})"
f"** of the {total_repositories} total public repositories"
" on GitHub that use a CC legal tool. Additionally,"
" many more use a non-CC use a Public domain"
" equivalent legal tools.\n"
f"**The results indicate that {cc_total:,} ({cc_percentage})** of the"
f" {total_repositories:,} total public repositories on GitHub use a CC"
" legal tool. Additionally, many more use a non-CC use a Public"
" domain equivalent legal tools. The fetched GitHub data creates a"
" a subtotal that showcases the different level of permission that"
" works are released under.\n"
"\n"
" The GitHub data showcases the different level of"
" rights reserved on repositories We have Public"
" domain which includes works released under CC0, 0BSD and Unlicense"
" meaning developers have waived all their rights to a software."
" Allowing anyone to freely use, modify, and distribute the code"
" without restriction."
" See more at"
"The public-domain-equivalent licenses include 0BSD, CC0, MIT-0 and"
" Unlicense. These licenses allow anyone to freely use, modify, and"
" distribute the code without restriction. See more at"
" [Public-domain-equivalent license]"
"(https://en.wikipedia.org/wiki/Public-domain-equivalent_license).\n"
" While a Permissive category of license contains works"
" under MIT-0 and CC BY 4.0 allows users to"
" reuse the code with some conditions and attribution"
"\n"
"The CC BY 4.0 license is a permissive license that allows users to"
" reuse the code with some conditions and attribution. See more at"
" [Permissive license]"
"(https://en.wikipedia.org/wiki/Permissive_software_license)"
" and Copyleft contains works under CC BY-SA 4.0."
" which requires any derivative works to be licensed"
" under the same terms."
"(https://en.wikipedia.org/wiki/Permissive_software_license).\n"
"\n"
"The CC BY-SA 4.0 license is a copyleft license which requires any"
" derivative works to be licensed under the same terms. See more at"
" [Copyleft](https://en.wikipedia.org/wiki/Copyleft).\n"
"\n"
"Thank you GitHub for providing public API"
" access to repository metadata!",
"Thank you GitHub for providing public API access to repository"
" metadata!",
)


def plot_totals_by_license_type(args):
def plot_distribution_by_license(args):
"""
Create plots showing totals by license type
Create a plot showing the subtotal distribution by license
"""
LOGGER.info(plot_totals_by_license_type.__doc__.strip())
LOGGER.info(plot_distribution_by_license.__doc__.strip())
file_path = shared.path_join(
PATHS["data_2-process"],
"github_totals_by_license.csv",
Expand All @@ -161,7 +158,7 @@ def plot_totals_by_license_type(args):
data_label = "Count"
data = shared.open_data_file(LOGGER, file_path, index_col=name_label)
data.sort_values(data_label, ascending=True, inplace=True)
title = "Totals by license type"
title = "Subtotal distribution by license"
plt = plot.combined_plot(
args=args,
data=data,
Expand All @@ -186,22 +183,18 @@ def plot_totals_by_license_type(args):
SECTION_TITLE,
title,
image_path,
"Plots showing totals by license type."
" This shows the distribution of different CC license"
" and non CC license used in GitHub repositories."
" Allowing Commons to evaluate how freely softwares on"
" GitHub are being used, modified, and shared"
" and how developers choose to share their works."
" See more at [SPDX License List]"
"(https://spdx.org/licenses/)",
"The plot shows the distribution of the different open content or"
" public-domain-equivalent licenses (0BSD, CC BY 4.0, CC BY-SA 4.0,"
" CC0 1.0, MIT-0, and Unlicense) used in the subtotal of GitHub"
" repositories.",
)


def plot_totals_by_restriction(args):
def plot_distribution_by_restriction(args):
"""
Create plots showing totals by restriction
Create a plot showing the subtotal distribution by restriction
"""
LOGGER.info(plot_totals_by_restriction.__doc__.strip())
LOGGER.info(plot_distribution_by_restriction.__doc__.strip())
file_path = shared.path_join(
PATHS["data_2-process"],
"github_totals_by_restriction.csv",
Expand All @@ -211,7 +204,7 @@ def plot_totals_by_restriction(args):
data_label = "Count"
data = shared.open_data_file(LOGGER, file_path, index_col=name_label)
data.sort_values(name_label, ascending=False, inplace=True)
title = "Totals by restriction"
title = "Subtotal distribution by restriction"
plt = plot.combined_plot(
args=args,
data=data,
Expand All @@ -235,10 +228,9 @@ def plot_totals_by_restriction(args):
SECTION_TITLE,
title,
image_path,
"Plots showing totals by different levels of restrictions."
" This shows the distribution of Public domain,"
" Permissive, and Copyleft"
" licenses used in GitHub repositories.",
"The plot shows the distribution of the different restrictions"
" (Copyleft, Permissive, Public domain) used in the subtotal of GitHub"
" repositories.",
)


Expand All @@ -251,8 +243,8 @@ def main():
)
shared.check_completion_file_exists(args, last_entry)
github_intro(args)
plot_totals_by_license_type(args)
plot_totals_by_restriction(args)
plot_distribution_by_license(args)
plot_distribution_by_restriction(args)

# Add and commit changes
args = shared.git_add_and_commit(
Expand Down
Loading
Loading