Automatic Metrics API

.github/workflows/get-metrics.py

@@ -0,0 +1,31 @@
+import logging
+import os
+
+import google
+from google.analytics.data_v1beta import BetaAnalyticsDataClient
+
+PRIVATE_KEY_ID = os.environ.get('PRIVATE_KEY_ID')
+PRIVATE_KEY = os.environ.get('PRIVATE_KEY')
+
+credentials_dict = {
+    'type': 'service_account',
+    'project_id': 'cisl-vast-pythia',
+    'private_key_id': PRIVATE_KEY_ID,
+    'private_key': PRIVATE_KEY,
+    'client_email': '[email protected]',
+    'client_id': '113402578114110723940',
+    'auth_uri': 'https://accounts.google.com/o/oauth2/auth',
+    'token_uri': 'https://oauth2.googleapis.com/token',
+    'auth_provider_x509_cert_url': 'https://www.googleapis.com/oauth2/v1/certs',
+    'client_x509_cert_url': 'https://www.googleapis.com/robot/v1/metadata/x509/pythia-metrics-api%40cisl-vast-pythia.iam.gserviceaccount.com',
+    'universe_domain': 'googleapis.com',
+}
+
+try:
+    client = BetaAnalyticsDataClient.from_service_account_info(credentials_dict)
+except google.auth.exceptions.MalformedError as e:
+    print('Malformed Error:', repr(e))
+    logging.error('Malformed Error:', repr(e))
+    logging.error('Credentials dict:', credentials_dict)
+
+    print(credentials_dict)

.github/workflows/nightly-build.yaml

@@ -6,7 +6,30 @@ on:
     - cron: '0 0 * * *' # Daily “At 00:00”
 
 jobs:
+  automate-metrics:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Automate Metrics
+        env:
+          PORTAL_ID: ${{  secrets.PORTAL_ID }}
+          FOUNDATIONS_ID: ${{ secrets.FOUNDATIONS_ID }}
+          COOKBOOKS_ID: ${{ secrets.COOKBOOKS_ID }}
+          PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}
+          PRIVATE_KEY_ID: ${{ secrets.PRIVATE_KEY_ID }}
+        run: |
+          python -m venv analytics-api
+          source analytics-api/bin/activate
+          pip install google-analytics-data cartopy matplotlib
+
+          curl -O https://raw.githubusercontent.com/jukent/projectpythia.github.io/main/.github/workflows/get-metrics.py
+          curl -O https://raw.githubusercontent.com/jukent/projectpythia.github.io/main/.github/workflows/write-metrics-md.py
+
+          python get-metrics.py
+          python write-metrics-md.py
+
   build:
+    needs: automate-metrics
     if: ${{ github.repository_owner == 'ProjectPythia' }}
     uses: ProjectPythia/cookbook-actions/.github/workflows/build-book.yaml@main
     with:
@@ -20,3 +43,10 @@ jobs:
     uses: ./.github/workflows/sphinx-link-checker.yaml
     with:
       path_to_source: 'portal'
+
+  deploy:
+      needs: build
+      uses: ProjectPythia/cookbook-actions/.github/workflows/deploy-book.yaml@main
+      with:
+        cname: projectpythia.org
+        publish_dir: 'portal/_build/html'

.github/workflows/publish-site.yaml

@@ -8,7 +8,30 @@ on:
   workflow_dispatch:
 
 jobs:
+  automate-metrics:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Automate Metrics
+        env:
+          PORTAL_ID: ${{  secrets.PORTAL_ID }}
+          FOUNDATIONS_ID: ${{ secrets.FOUNDATIONS_ID }}
+          COOKBOOKS_ID: ${{ secrets.COOKBOOKS_ID }}
+          PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}
+          PRIVATE_KEY_ID: ${{ secrets.PRIVATE_KEY_ID }}
+        run: |
+          python -m venv analytics-api
+          source analytics-api/bin/activate
+          pip install google-analytics-data cartopy matplotlib
+
+          curl -O https://raw.githubusercontent.com/jukent/projectpythia.github.io/main/.github/workflows/get-metrics.py
+          curl -O https://raw.githubusercontent.com/jukent/projectpythia.github.io/main/.github/workflows/write-metrics-md.py
+
+          python get-metrics.py
+          python write-metrics-md.py
+
   build:
+    needs: automate-metrics
     uses: ProjectPythia/cookbook-actions/.github/workflows/build-book.yaml@main
     with:
       environment_file: 'environment.yml'

.github/workflows/trigger-preview.yaml

@@ -8,7 +8,30 @@ on:
       - completed
 
 jobs:
+  automate-metrics:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Automate Metrics
+        env:
+          PORTAL_ID: ${{  secrets.PORTAL_ID }}
+          FOUNDATIONS_ID: ${{ secrets.FOUNDATIONS_ID }}
+          COOKBOOKS_ID: ${{ secrets.COOKBOOKS_ID }}
+          PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}
+          PRIVATE_KEY_ID: ${{ secrets.PRIVATE_KEY_ID }}
+        run: |
+          python -m venv analytics-api
+          source analytics-api/bin/activate
+          pip install google-analytics-data cartopy matplotlib
+
+          curl -O https://raw.githubusercontent.com/jukent/projectpythia.github.io/main/.github/workflows/get-metrics.py
+          curl -O https://raw.githubusercontent.com/jukent/projectpythia.github.io/main/.github/workflows/write-metrics-md.py
+
+          python get-metrics.py
+          python write-metrics-md.py
+
   find-pull-request:
+    needs: automate-metrics
     uses: ProjectPythia/cookbook-actions/.github/workflows/find-pull-request.yaml@main
   deploy-preview:
     needs: find-pull-request

.github/workflows/trigger-site-build.yaml

@@ -3,6 +3,28 @@ on:
   pull_request:
 
 jobs:
+  automate-metrics:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Automate Metrics
+        env:
+          PORTAL_ID: ${{  secrets.PORTAL_ID }}
+          FOUNDATIONS_ID: ${{ secrets.FOUNDATIONS_ID }}
+          COOKBOOKS_ID: ${{ secrets.COOKBOOKS_ID }}
+          PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}
+          PRIVATE_KEY_ID: ${{ secrets.PRIVATE_KEY_ID }}
+        run: |
+          python -m venv analytics-api
+          source analytics-api/bin/activate
+          pip install google-analytics-data cartopy matplotlib
+
+          curl -O https://raw.githubusercontent.com/jukent/projectpythia.github.io/main/.github/workflows/get-metrics.py
+          curl -O https://raw.githubusercontent.com/jukent/projectpythia.github.io/main/.github/workflows/write-metrics-md.py
+
+          python get-metrics.py
+          python write-metrics-md.py
+
   build:
     uses: ProjectPythia/cookbook-actions/.github/workflows/build-book.yaml@main
     with:

.github/workflows/write-metrics-md.py

@@ -0,0 +1,38 @@
+import datetime
+import json
+
+
+def process_user_data(user_data_file, bar_plot_file, map_plot_file, markdown_file):
+    """
+    Reads user data from a JSON file and writes it to a markdown file.
+
+    Args:
+        user_data_file: Path to the JSON file containing user data.
+        markdown_file: Path to the output markdown file.
+    """
+    now = datetime.datetime.now()
+
+    with open(user_data_file, 'r') as f:
+        user_data = json.load(f)
+
+    # Write processed data to markdown file
+    with open(markdown_file, 'w') as f:
+        f.write('# Metrics \n\n')
+        f.write(f'Last Updated: {now}\n\n')
+        f.write('Total Users:\n\n')
+        for key in user_data:
+            f.write(f'{key}: {(user_data[key])}\n')
+        f.write('\n')
+        f.write('![Top Pages](bar_plot_file)')
+        f.write('\n\n')
+        f.write('![Users by Country](../.github/workflows/map_plot_file)')
+        f.write('\n')
+    f.close()
+
+
+if __name__ == '__main__':
+    user_data_file = 'user_metrics.json'
+    bar_plot_file = '../.github/workflows/bypage.png'
+    map_plot_file = '../.github/workflows/bycountry.png'
+    markdown_file = 'portal/metrics.md'
+    process_user_data(user_data_file, bar_plot_file, map_plot_file, markdown_file)

.gitignore

@@ -138,3 +138,8 @@ portal/code_of_conduct.md
 portal/resource-gallery.md
 portal/resource-gallery/*.md
 resource-gallery-submission-input.json
+
+# Analytics
+.github/workflows/analytics-api/
+.github/workflows/*.json
+.github/workflows/*.png

portal/_templates/footer-menu.html

@@ -8,6 +8,7 @@ <h1>{{ _("About") }}</h1>
             <li><a href="https://projectpythia.org/about.html">{{ _("About Project Pythia") }}</a></li>
             <li><a href="https://foundations.projectpythia.org/preamble/how-to-use.html">{{ _("How to use Pythia Foundations") }}</a></li>
             <li><a href="https://projectpythia.org/#how-to-cite">{{ _("How to Cite") }}</a></li>
+            <li><a href="https://projectpythia.org/metrics.html">{{ _("Metrics") }}</a></li>
           </ul>
         </div>
         <div class="col-9 col-sm-4 col-md-4 col-lg-3 footer-menu-col">

portal/index.md

@@ -227,4 +227,5 @@ contributing.md
 code_of_conduct.md
 cookbook-gallery.md
 resource-gallery.md
+metrics.md
 ```

portal/metrics.md

@@ -0,0 +1 @@
+# Metrics