feat: adding package metrics

Author: clatapie

.github/workflows/update-pr-data.yml

@@ -47,6 +47,8 @@ jobs:
         run: python scripts/get-sprint-data.py
       - name: get-review-contributors
         run: python scripts/get-review-contributors.py
+      - name: get-package-data
+        run: python scripts/get-package-data.py
       - name: Cache metrics
         uses: actions/upload-artifact@v4
         with:

.gitignore

@@ -16,6 +16,7 @@ node_modules/*
 # don't want them to accidentally push them to the repo.
 .env
 
+.venv/
 /.quarto/
 _site/*
 _output/*

_data/package_data.csv

@@ -0,0 +1,90 @@
+---
+title: pyOpenSci Package Metrics Over Time
+jupyter: python3
+execute:
+  echo: false
+---
+
+This data provides metrics accross all the PyOpenSci packages. 
+
+```{python}
+#| echo: false
+#|
+import ast
+import warnings
+from itables import show
+from pathlib import Path
+
+import altair as alt
+import pandas as pd
+
+# This is a local module that stores the plot theme
+from pyosmetrics.plot_theme import load_poppins_font, register_and_enable_poppins_theme
+
+pd.options.mode.chained_assignment = None
+pd.options.future.infer_string = True
+
+# Suppress all warnings
+warnings.filterwarnings("ignore")
+
+# Load the & register Poppins theme
+load_poppins_font()
+register_and_enable_poppins_theme()
+```
+
+```{python}
+# Get the current notebook directory
+package_data_path = Path.cwd().parents[0] / "_data" / "package_data.csv" 
+
+# Read the DataFrame from the CSV file
+package_df = pd.read_csv(package_data_path)
+```
+
+### Forks count per repositories
+
+```{python}
+# Parse the "gh_meta" column back into dictionaries
+package_df['gh_meta'] = package_df['gh_meta'].apply(
+  lambda x: ast.literal_eval(x) if isinstance(x, str) else x
+)
+
+# Extract "forks_count" value from the 'gh_meta' column
+package_df['forks_count'] = package_df['gh_meta'].apply(
+  lambda x: x.get('forks_count') if isinstance(x, dict) else None
+)
+```
+
+
+```{python}
+# Render a graph plot of the forks count
+chart = (
+    alt.Chart(package_df).mark_bar()
+    .encode(
+        x=alt.X('package_name', sort='-y')
+            .title('Package name')
+            .axis(labelAngle=45),
+        y=alt.Y('forks_count:Q')
+            .title('Forks Count'),
+    )
+    .properties(title="Forks Count per Repository")
+    .configure_legend(
+        orient='top',
+        titleAnchor='middle',
+        direction='horizontal',
+        labelFontSize=5,
+    )
+    .interactive()
+)
+
+chart
+```
+
+Find bellow the detailed count for each PyOpenSci repository.
+
+```{python}
+# Create an itable to display the DataFrame
+from itables import show
+
+# Display the results as an interactive table
+show(package_df[['package_name', 'forks_count']], max_rows=10)
+```

contributors/package.qmd

@@ -24,6 +24,7 @@ If you are looking to contribute, checkout our [README file](https://www.github.
 
 * [Contributor Data](/contributors/contributors.html)
 * [Sprint Contributor Data](/contributors/sprints.qmd)
+* [Package Data](/contributors/package.qmd)
 :::
 
 

index.qmd

@@ -7,3 +7,4 @@ pyarrow
 itables # interactive tables!
 tqdm
 nox
+pygithub # for github API

requirements.txt

@@ -0,0 +1,43 @@
+import os
+
+import github
+import pandas as pd
+import yaml
+from pathlib import Path
+
+ACCESS_TOKEN = os.getenv("GITHUB_TOKEN")
+gh = github.Github(ACCESS_TOKEN)
+
+def get_package_data():
+    """
+    Get package data from GitHub repository.
+
+    Returns
+    -------
+    dict
+        Dictionary containing package data.
+    """
+    
+    # Get the repository
+    repo = gh.get_repo("pyOpenSci/pyopensci.github.io")
+    
+    # Get the ``_data/packages.yml`` file
+    package_data = repo.get_contents("_data/packages.yml")
+    package_data = package_data.decoded_content.decode("utf-8")
+    
+    # Load the YAML content
+    package_data = yaml.safe_load(package_data)
+    
+    # Convert the dictionary to a DataFrame
+    df = pd.DataFrame.from_dict(package_data)
+    
+    return df
+
+if __name__ == "__main__":
+    package_df = get_package_data()
+    
+    dir_path = Path("_data")
+    file_path = dir_path / "package_data.csv"
+
+    dir_path.mkdir(parents=True, exist_ok=True)
+    package_df.to_csv(file_path, index=False)