GH actions for traffic monitoring

.github/workflows/GH_traffic.yml

@@ -0,0 +1,31 @@
+on:
+  workflow_dispatch:   
+  schedule: 
+    # runs once a day
+    - cron: "55 23 * * *"
+
+jobs:
+  # This workflow contains a single job called "traffic"
+  traffic:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+    # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+    - uses: actions/checkout@v2
+
+    # Calculates traffic and clones and stores in CSV file
+    - name: GitHub traffic 
+      uses: sangonzal/[email protected]
+      env:
+        TRAFFIC_ACTION_TOKEN: ${{ secrets.TRAFFIC_ACTION_TOKEN }}
+        REPOSITORY_NAME: "NMRLipids/Databank"
+
+    # Commits files to repository
+    - name: Commit changes
+      uses: EndBug/add-and-commit@v4
+      with:
+        author_name: GitHub action
+        message: "GitHub traffic"
+        add: "./traffic/*"

.github/workflows/zenodo_stats.yml

@@ -0,0 +1,38 @@
+on:
+  workflow_dispatch:   
+  schedule:
+    # runs once a day
+    - cron: "05 22 * * *"
+
+jobs:
+  zenodo_stats:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+          working-directory: .
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+
+    steps:
+    - name: Check out repo
+      uses: actions/checkout@v4 
+
+    - name: Check out NMRLipids/Databank
+      uses: actions/checkout@v4
+      with:
+        repository: NMRLipids/Databank
+        path: NMRLipidsDB
+
+    # Get zenodo DOIs and query stats from API
+    - name: Zenodo stats
+      run: |
+        .scripts/zenodo_stats.sh
+
+    # Commits files to repository
+    - name: Commit changes
+      uses: EndBug/add-and-commit@v4
+      with:
+        author_name: GitHub action
+        message: "Zenodo stats"
+        add: 'traffic/zenodo_stats.csv'

.scripts/zenodo_stats.sh

@@ -0,0 +1,64 @@
+#!/bin/bash
+
+# Output file for DOIs
+doi_output_file="zenodo_dois.txt"
+
+# Clear output file
+> "$doi_output_file"
+
+# Current date
+date=$(date --iso-8601)
+
+
+# Find all README.yml files and extract the zenodo DOI key
+find NMRLipidsDB -name "README.yaml" | while read -r file; do
+    echo "Processing $file"
+
+    doi=$(grep -o 'DOI: .*10.5281/zenodo.*' "$file" | awk '{print $2}')
+    if [ -n "$doi" ]; then
+        echo "DOI found: $doi"
+        echo "$doi" >> "$doi_output_file" 
+    else
+        echo "No DOI found in $file"
+    fi
+done
+
+mkdir -p traffic
+stats_output_file="traffic/zenodo_stats.csv"
+
+if [ ! -f "$stats_output_file" ]; then
+    echo "doi,date,downloads,unique_downloads,views,unique_views,version_downloads,version_unique_downloads,version_views,version_unique_views" > "$stats_output_file"
+fi
+
+mapfile -t dois_array < zenodo_dois.txt
+
+for doi in "${dois_array[@]}"; do
+    # remove the base DOI part
+    identifier=$(echo "$doi" | sed 's/10\.5281\/zenodo\.//')
+    #echo "DOI $doi"
+    #echo "ID $identifier"
+
+    # Fetch JSON data
+    response=$(curl -s "https://zenodo.org/api/records/$identifier")
+
+    # Check if successful
+    if [[ $? -eq 0 ]]; then
+        #echo "URL https://zenodo.org/api/records/$identifier"
+	#echo "RESPONSE: $response" 
+
+        downloads=$(echo "$response" | jq '.stats.downloads')
+        unique_downloads=$(echo "$response" | jq '.stats.unique_downloads')
+        views=$(echo "$response" | jq '.stats.views')
+        unique_views=$(echo "$response" | jq '.stats.unique_views')
+        version_downloads=$(echo "$response" | jq '.stats.version_downloads')
+        version_unique_downloads=$(echo "$response" | jq '.stats.version_unique_downloads')
+        version_views=$(echo "$response" | jq '.stats.version_views')
+        version_unique_views=$(echo "$response" | jq '.stats.version_unique_views')
+
+        # Write the extracted data to CSV
+        #echo "Got stats for $doi"
+	echo "$doi,$date,$downloads,$unique_downloads,$views,$unique_views,$version_downloads,$version_unique_downloads,$version_views,$version_unique_views" >> "$stats_output_file"
+    else
+        echo "Failed to fetch data for DOI: $doi"
+    fi
+done

traffic/clones.csv

@@ -0,0 +1,35 @@
+_date,total_clones,unique_clones
+2024-12-09,1,1
+2024-12-16,15,2
+2024-12-17,3,1
+2024-12-18,3,2
+2024-12-19,1,1
+2024-12-20,1,1
+2024-12-21,2,2
+2024-12-22,1,1
+2024-12-23,1,1
+2024-12-24,1,1
+2024-12-25,1,1
+2024-12-26,1,1
+2024-12-27,1,1
+2024-12-28,1,1
+2024-12-29,1,1
+2024-12-30,1,1
+2024-12-31,1,1
+2025-01-01,1,1
+2025-01-02,1,1
+2025-01-03,1,1
+2025-01-04,1,1
+2025-01-05,1,1
+2025-01-06,2,2
+2025-01-07,2,1
+2025-01-08,1,1
+2025-01-09,1,1
+2025-01-10,1,1
+2025-01-11,1,1
+2025-01-12,1,1
+2025-01-13,2,2
+2025-01-14,1,1
+2025-01-15,1,1
+2025-01-16,1,1
+2025-01-17,1,1

traffic/views.csv

@@ -0,0 +1,39 @@
+_date,total_views,unique_views
+2024-12-04,25,8
+2024-12-05,10,3
+2024-12-06,2,1
+2024-12-07,26,4
+2024-12-08,8,2
+2024-12-09,68,7
+2024-12-10,28,4
+2024-12-11,43,5
+2024-12-12,14,6
+2024-12-13,43,6
+2024-12-14,3,1
+2024-12-15,5,1
+2024-12-16,47,5
+2024-12-17,59,6
+2024-12-18,8,1
+2024-12-19,9,3
+2024-12-20,49,5
+2024-12-22,21,2
+2024-12-23,5,2
+2024-12-25,1,1
+2024-12-26,10,3
+2024-12-27,1,1
+2024-12-28,12,1
+2025-01-01,1,1
+2025-01-02,48,4
+2025-01-03,5,3
+2025-01-04,1,1
+2025-01-06,8,5
+2025-01-07,15,3
+2025-01-08,1,1
+2025-01-10,31,3
+2025-01-11,29,3
+2025-01-12,40,4
+2025-01-13,2,1
+2025-01-14,3,2
+2025-01-15,1,1
+2025-01-16,31,4
+2025-01-17,44,3