Made requested changes

Author: oree-xx

scripts/2-process/github_process.py

@@ -44,7 +44,7 @@ def parse_arguments():
         help="Enable saving results (default: False)",
     )
     parser.add_argument(
-        "--enable_git",
+        "--enable-git",
         action="store_true",
         help="Enable git actions such as fetch, merge, add, commit, and push"
         " (default: False)",
@@ -70,43 +70,6 @@ def data_to_csv(args, data, file_path):
     )
 
 
-def process_totals_by_code_license(args, count_data):
-    """
-    Processing count data: totals by Code License
-    """
-    LOGGER.info(process_totals_by_code_license.__doc__.strip())
-    data = {
-        "Code License": 0,
-        "Content License": 0,
-    }
-    for row in count_data.itertuples(index=False):
-        tool = str(row.TOOL_IDENTIFIER)
-        count = int(row.COUNT)
-
-        if tool == "Total public repositories":
-            continue
-
-        if tool in [
-            "MIT No Attribution",
-            "BSD Zero Clause License",
-            "Unlicense",
-        ]:
-            key = "Code License"
-        elif tool in ["CC0 1.0", "CC BY 4.0", "CC-BY-SA 4.0"]:
-            key = "Content License"
-        else:
-            continue
-
-        data[key] += count
-    data = pd.DataFrame(data.items(), columns=["Category", "Count"])
-    data.sort_values("Count", ascending=False, inplace=True)
-    data.reset_index(drop=True, inplace=True)
-    file_path = shared.path_join(
-        PATHS["data_phase"], "github_totals_by_code_license.csv"
-    )
-    data_to_csv(args, data, file_path)
-
-
 def process_totals_by_license(args, count_data):
     """
     Processing count data: totals by License
@@ -124,7 +87,7 @@ def process_totals_by_license(args, count_data):
         data[tool] = count
 
     data = pd.DataFrame(data.items(), columns=["License", "Count"])
-    data.sort_values("Count", ascending=False, inplace=True)
+    data.sort_values("License", ascending=True, inplace=True)
     data.reset_index(drop=True, inplace=True)
     file_path = shared.path_join(
         PATHS["data_phase"], "github_totals_by_license.csv"
@@ -158,52 +121,14 @@ def process_totals_by_restriction(args, count_data):
 
         data[key] += count
     data = pd.DataFrame(data.items(), columns=["Category", "Count"])
-    data.sort_values("Count", ascending=False, inplace=True)
+    data.sort_values("Count", ascending=True, inplace=True)
     data.reset_index(drop=True, inplace=True)
     file_path = shared.path_join(
         PATHS["data_phase"], "github_totals_by_restriction.csv"
     )
     data_to_csv(args, data, file_path)
 
 
-def process_totals_by_rights_reserved(args, count_data):
-    """
-    Processing count data: totals by Rights Reserved
-    """
-    LOGGER.info(process_totals_by_rights_reserved.__doc__.strip())
-    data = {
-        "Rights reserved": 0,
-        "No rights reserved": 0,
-    }
-    for row in count_data.itertuples(index=False):
-        tool = str(row.TOOL_IDENTIFIER)
-        count = int(row.COUNT)
-
-        if tool == "Total public repositories":
-            continue
-
-        if tool in [
-            "MIT No Attribution",
-            "BSD Zero Clause License",
-            "CC0 1.0",
-            "Unlicense",
-        ]:
-            key = "No rights reserved"
-        elif tool in ["CC BY 4.0", "CC-BY-SA 4.0"]:
-            key = "Rights reserved"
-        else:
-            continue
-
-        data[key] += count
-    data = pd.DataFrame(data.items(), columns=["Category", "Count"])
-    data.sort_values("Count", ascending=False, inplace=True)
-    data.reset_index(drop=True, inplace=True)
-    file_path = shared.path_join(
-        PATHS["data_phase"], "github_totals_by_rights_reserved.csv"
-    )
-    data_to_csv(args, data, file_path)
-
-
 # def load_quarter_data(quarter):
 #     """
 #     Load data for a specific quarter.
@@ -255,9 +180,7 @@ def main():
     file_count = shared.path_join(PATHS["data_1-fetch"], "github_1_count.csv")
     count_data = pd.read_csv(file_count, usecols=["TOOL_IDENTIFIER", "COUNT"])
     process_totals_by_license(args, count_data)
-    process_totals_by_rights_reserved(args, count_data)
     process_totals_by_restriction(args, count_data)
-    process_totals_by_code_license(args, count_data)
 
     # Push changes
     args = shared.git_add_and_commit(

scripts/3-report/github_report.py

@@ -26,7 +26,7 @@
 # Setup
 LOGGER, PATHS = shared.setup(__file__)
 QUARTER = os.path.basename(PATHS["data_quarter"])
-SECTION = "Github Data"
+SECTION = "GitHub Data"
 
 
 def parse_arguments():
@@ -88,7 +88,7 @@ def load_data(args):
 
 def github_intro(args):
     """
-    Write Github introduction.
+    Write GitHub introduction.
     """
     LOGGER.info(github_intro.__doc__.strip())
     file_path = shared.path_join(
@@ -105,25 +105,25 @@ def github_intro(args):
         "Overview",
         None,
         None,
-        "Github data uses the `total_count` returned by"
+        "GitHub data uses the `total_count` returned by"
         " API for search queries of the SPDX IDENTIFIER URLS"
         "\n"
-        f"**The results indicate that a total of {total_repositories}"
-        "repositories on GitHub use a mix of some rights reserved and"
-        "no rights reserved licenses which showcases the usage of"
-        "attribution based Creative Commons (CC) legal tool"
+        f"**The results indicate that a total of {total_repositories} "
+        "repositories on GitHub use a mix of some rights reserved and "
+        "no rights reserved licenses which showcases the usage of "
+        "attribution based Creative Commons (CC) legal tool "
         "and Public domain equivalent.**\n"
         "/n"
         "Thank you GitHub for providing public access to"
         "repository metadata through its API.",
     )
 
 
-def Plot_by_license_type(args):
+def plot_totals_by_license_type(args):
     """
-    Create plots for the languages with highest usage of latest tools
+    Create plots showing totals by license type
     """
-    LOGGER.info(plot_totals_by_code_license.__doc__.strip())
+    LOGGER.info(plot_totals_by_license_type.__doc__.strip())
     file_path = shared.path_join(
         PATHS["data_2-process"],
         "github_totals_by_license.csv",
@@ -132,7 +132,7 @@ def Plot_by_license_type(args):
     name_label = "License"
     data_label = "Count"
     data = pd.read_csv(file_path, index_col=name_label)
-    data.sort_values(name_label, ascending=False, inplace=True)
+    data.sort_values(data_label, ascending=True, inplace=True)
     title = "Totals by license type"
     plt = plot.combined_plot(
         args=args,
@@ -157,55 +157,20 @@ def Plot_by_license_type(args):
         SECTION,
         title,
         image_path,
-        "Plots showing totals by license type.",
-    )
-
-
-def plot_totals_by_code_license(args):
-    """
-    Create plots for the languages with highest usage of latest tools
-    """
-    LOGGER.info(plot_totals_by_code_license.__doc__.strip())
-    file_path = shared.path_join(
-        PATHS["data_2-process"],
-        "github_totals_by_code_license.csv",
-    )
-    LOGGER.info(f"data file: {file_path.replace(PATHS['repo'], '.')}")
-    name_label = "Category"
-    data_label = "Count"
-    data = pd.read_csv(file_path, index_col=name_label)
-    data.sort_values(name_label, ascending=False, inplace=True)
-    title = "Totals by Code License"
-    plt = plot.combined_plot(
-        args=args,
-        data=data,
-        title=title,
-        name_label=name_label,
-        data_label=data_label,
-    )
-
-    image_path = shared.path_join(
-        PATHS["data_phase"], "github_totals_code_license.png"
-    )
-    LOGGER.info(f"image file: {image_path.replace(PATHS['repo'], '.')}")
-
-    if args.enable_save:
-        # Create the directory if it does not exist
-        os.makedirs(PATHS["data_phase"], exist_ok=True)
-        plt.savefig(image_path)
-
-    shared.update_readme(
-        args,
-        SECTION,
-        title,
-        image_path,
-        "Plots showing totals by code license vs content license.",
+        "Plots showing totals by license type."
+        "This shows the distribution of different licenses "
+        "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/)",
     )
 
 
 def plot_totals_by_restriction(args):
     """
-    Create plots for the languages with highest usage of latest tools
+    Create plots showing totals by restriction
     """
     LOGGER.info(plot_totals_by_restriction.__doc__.strip())
     file_path = shared.path_join(
@@ -240,48 +205,22 @@ def plot_totals_by_restriction(args):
         SECTION,
         title,
         image_path,
-        "Plots showing totals by restrictions.",
-    )
-
-
-def plot_totals_by_rights_reserved(args):
-    """
-    Create plots for the languages with highest usage of latest tools
-    """
-    LOGGER.info(plot_totals_by_rights_reserved.__doc__.strip())
-    file_path = shared.path_join(
-        PATHS["data_2-process"],
-        "github_totals_by_rights_reserved.csv",
-    )
-    LOGGER.info(f"data file: {file_path.replace(PATHS['repo'], '.')}")
-    name_label = "Category"
-    data_label = "Count"
-    data = pd.read_csv(file_path, index_col=name_label)
-    data.sort_values(name_label, ascending=False, inplace=True)
-    title = "Totals by Rights Reserved vs No Rights Reserved"
-    plt = plot.combined_plot(
-        args=args,
-        data=data,
-        title=title,
-        name_label=name_label,
-        data_label=data_label,
-    )
-
-    image_path = shared.path_join(
-        PATHS["data_phase"], "github_rights_reserved.png"
-    )
-    LOGGER.info(f"image file: {image_path.replace(PATHS['repo'], '.')}")
-    if args.enable_save:
-        # Create the directory if it does not exist
-        os.makedirs(PATHS["data_phase"], exist_ok=True)
-        plt.savefig(image_path)
-
-    shared.update_readme(
-        args,
-        SECTION,
-        title,
-        image_path,
-        "Plots showing totals by rights reserved vs No rights reserved.",
+        "Plots showing totals by different levels of restrictions."
+        "Public domain 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 "
+        "[Public-domain-equivalent license]"
+        "(https://en.wikipedia.org/wiki/Public-domain-equivalent_license) "
+        "While Permissive contains works under MIT-0 and CC BY 4.0 "
+        "allows users to reuse the code with some conditions and attribution "
+        "[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. "
+        "[Copyleft](https://en.wikipedia.org/wiki/Copyleft) ",
     )
 
 
@@ -290,10 +229,8 @@ def main():
     shared.paths_log(LOGGER, PATHS)
     shared.git_fetch_and_merge(args, PATHS["repo"])
     github_intro(args)
+    plot_totals_by_license_type(args)
     plot_totals_by_restriction(args)
-    plot_totals_by_code_license(args)
-    Plot_by_license_type(args)
-    plot_totals_by_rights_reserved(args)
 
     # Add and commit changes
     args = shared.git_add_and_commit(