Keep only modified report and shared scripts

Author: Joyakis

scripts/3-report/gcs_report.py

@@ -79,8 +79,7 @@ def gcs_intro(args):
     )
     LOGGER.info(f"data file: {file_path.replace(PATHS['repo'], '.')}")
     name_label = "CC legal tool product"
-    data = shared.open_data_file(LOGGER, file_path)
-    data.set_index(name_label, inplace=True)
+    data = shared.open_data_file(LOGGER, file_path, index_col=name_label)
     total_count = f"{data['Count'].sum():,d}"
     shared.update_readme(
         args,
@@ -111,8 +110,7 @@ def plot_products(args):
     )
     LOGGER.info(f"data file: {file_path.replace(PATHS['repo'], '.')}")
     name_label = "CC legal tool product"
-    data = shared.open_data_file(LOGGER, file_path)
-    data.set_index(name_label, inplace=True)
+    data = shared.open_data_file(LOGGER, file_path, index_col=name_label)
 
     data = data[::-1]  # reverse order
 
@@ -158,8 +156,7 @@ def plot_tool_status(args):
     )
     LOGGER.info(f"data file: {file_path.replace(PATHS['repo'], '.')}")
     name_label = "CC legal tool"
-    data = shared.open_data_file(LOGGER, file_path)
-    data.set_index(name_label, inplace=True)
+    data = shared.open_data_file(LOGGER, file_path, index_col=name_label)
     data.sort_values(name_label, ascending=False, inplace=True)
 
     title = "CC legal tools status"
@@ -202,8 +199,7 @@ def plot_latest_tools(args):
     )
     LOGGER.info(f"data file: {file_path.replace(PATHS['repo'], '.')}")
     name_label = "CC legal tool"
-    data = shared.open_data_file(LOGGER, file_path)
-    data.set_index(name_label, inplace=True)
+    data = shared.open_data_file(LOGGER, file_path, index_col=name_label)
     data.sort_values(name_label, ascending=False, inplace=True)
 
     title = "Latest CC legal tools"
@@ -245,8 +241,7 @@ def plot_prior_tools(args):
     )
     LOGGER.info(f"data file: {file_path.replace(PATHS['repo'], '.')}")
     name_label = "CC legal tool"
-    data = shared.open_data_file(LOGGER, file_path)
-    data.set_index(name_label, inplace=True)
+    data = shared.open_data_file(LOGGER, file_path, index_col=name_label)
     data.sort_values(name_label, ascending=False, inplace=True)
 
     title = "Prior CC legal tools"
@@ -291,8 +286,7 @@ def plot_retired_tools(args):
     )
     LOGGER.info(f"data file: {file_path.replace(PATHS['repo'], '.')}")
     name_label = "CC legal tool"
-    data = shared.open_data_file(LOGGER, file_path)
-    data.set_index(name_label, inplace=True)
+    data = shared.open_data_file(LOGGER, file_path, index_col=name_label)
     data.sort_values(name_label, ascending=False, inplace=True)
 
     title = "Retired CC legal tools"
@@ -338,8 +332,7 @@ def plot_countries_highest_usage(args):
     LOGGER.info(f"data file: {file_path.replace(PATHS['repo'], '.')}")
     name_label = "Country"
     data_label = "Count"
-    data = shared.open_data_file(LOGGER, file_path)
-    data.set_index(name_label, inplace=True)
+    data = shared.open_data_file(LOGGER, file_path, index_col=name_label)
     total_count = f"{data['Count'].sum():,d}"
     data.sort_values(data_label, ascending=False, inplace=True)
     data = data[:10]  # limit to highest 10
@@ -392,8 +385,7 @@ def plot_languages_highest_usage(args):
     LOGGER.info(f"data file: {file_path.replace(PATHS['repo'], '.')}")
     name_label = "Language"
     data_label = "Count"
-    data = shared.open_data_file(LOGGER, file_path)
-    data.set_index(name_label, inplace=True)
+    data = shared.open_data_file(LOGGER, file_path, index_col=name_label)
     total_count = f"{data['Count'].sum():,d}"
     data.sort_values(data_label, ascending=False, inplace=True)
     data = data[:10]  # limit to highest 10

scripts/3-report/github_report.py

@@ -93,8 +93,7 @@ def github_intro(args):
     )
     LOGGER.info(f"data file: {file_path.replace(PATHS['repo'], '.')}")
     name_label = "TOOL_IDENTIFIER"
-    data = shared.open_data_file(LOGGER, file_path)
-    data.set_index(name_label, inplace=True)
+    data = shared.open_data_file(LOGGER, file_path, index_col=name_label)
     total_repositories = data.loc["Total public repositories", "COUNT"]
     cc_total = data[data.index.str.startswith("CC")]["COUNT"].sum()
     cc_percentage = f"{(cc_total / total_repositories) * 100:.2f}%"
@@ -149,8 +148,7 @@ def plot_totals_by_license_type(args):
     LOGGER.info(f"data file: {file_path.replace(PATHS['repo'], '.')}")
     name_label = "License"
     data_label = "Count"
-    data = shared.open_data_file(LOGGER, file_path)
-    data.set_index(name_label, inplace=True)
+    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"
     plt = plot.combined_plot(
@@ -199,8 +197,7 @@ def plot_totals_by_restriction(args):
     LOGGER.info(f"data file: {file_path.replace(PATHS['repo'], '.')}")
     name_label = "Category"
     data_label = "Count"
-    data = shared.open_data_file(LOGGER, file_path)
-    data.set_index(name_label, inplace=True)
+    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"
     plt = plot.combined_plot(

scripts/shared.py

@@ -67,7 +67,12 @@ def get_session(accept_header=None, session=None):
     return session
 
 
-def open_data_file(logger, file_path, usecols=None):
+def open_data_file(
+    logger,
+    file_path,
+    usecols=None,
+    index_col=None,
+):
     """
     Open a CSV data file safely and convert
     expected errors into QuantifyingException.
@@ -76,27 +81,23 @@ def open_data_file(logger, file_path, usecols=None):
     """
     try:
         # Reading the file
-        return pd.read_csv(file_path, usecols=usecols)
-
+        return pd.read_csv(file_path, usecols=usecols, index_col=index_col)
     # File does not exist
     except FileNotFoundError:
         raise QuantifyingException(
             message=f"Data file not found: {file_path}", exit_code=1
         )
-
     # Empty or invalid CSV file
     except pd.errors.EmptyDataError:
         raise QuantifyingException(
             message=f"CSV file is empty or invalid: {file_path}", exit_code=1
         )
-
     # Permission denied
     except PermissionError:
         raise QuantifyingException(
             message=f"Permission denied when accessing data file: {file_path}",
             exit_code=1,
         )
-
     # Any other unexpected issue
     except Exception as e:
         raise QuantifyingException(