Metrics API test (#408)

* Create automate-metrics.yaml

* outline for automate-metrics.yaml

* Create get-metrics.py

* Update automate-metrics.yaml

* Update automate-metrics.yaml

* Update footer-menu.html with metrics

* Create metrics.md

* add json_extract to extensions

* Update get-metrics.py to also write file

* Update get-metrics.py with returned condition

* Update automate-metrics.yaml

* pre-commit

* use os to access passed in keys

* fix double quoted strings

* add jsonextract to environment.yml

* write metrics.md in a python file

* rm from config

* use env files

* update comment

* state with a table

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* rm table because it won't format and add to toc tree

* add dispatch

* starting metrics file, and - vs _

* pre-commit

* fix write-metrics

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: jukent

.github/workflows/automate-metrics.yaml

@@ -0,0 +1,48 @@
+name: Update User Metrics
+
+on:
+  workflow_dispatch:
+  schedule:
+    # Weekly Every Monday at 1PM UTC
+    - cron: '0 13 * * 1'
+
+env:
+  portal_id: ${{  secrets.GA4_PORTAL_ID }}
+  foundations_id: ${{ secrets.GA4_FOUNDATIONS_ID }}
+  cookbooks_id: ${{ secrets.GA4_COOKBOOKS_ID }}
+
+jobs:
+  main:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set Credentials
+        uses: mobiledevops/secret-to-file-action@v1
+        with:
+          base64-encoded-secret: ${{ secrets.GOOGLE_ANALYTICS_API_CREDENTIALS }}
+          filename: "credentials.json"
+          is-executable: true
+          working-directory: "."
+      - run: export GOOGLE_APPLICATION_CREDENTIALS="credentials.json"
+
+      - name: Set-Up Virtual Environment
+        run: |
+          python -m venv analytics-api
+          source analytics-api/bin/activate
+          pip install google-analytics-data
+
+      - name: Get and Write Metrics to JSON
+        run: python get-metrics.py
+
+      - name: Write Markdown File
+        run: python write-metrics-md.py
+
+      - name: Push Changes
+        if: steps.Get-and-Write-Metrics.outputs == 1  # Conditional step execution
+        run: |
+          git config --global user.name "${{ github.actor }}"
+          git config --global user.email "${{ github.actor }}@users.noreply.github.com"
+          git add user_metrics.json
+          git add ../portal/metrics.md
+          git commit -m "Update user metrics"
+          git push

.github/workflows/get-metrics.py

@@ -0,0 +1,85 @@
+import json
+import os
+
+from google.analytics.data_v1beta import BetaAnalyticsDataClient
+from google.analytics.data_v1beta.types import DateRange, Metric, RunReportRequest
+
+PORTAL_ID = os.environ['portal_id']
+FOUNDATIONS_ID = os.environ['foundations_id']
+COOKBOOKS_ID = os.environ['cookbook_id']
+
+
+def _run_total_users_report(property_id):
+    """Fetches total users for a given property ID
+
+    Args:
+        property_id: The Google Analytics 4 property ID
+
+    Returns:
+        int: The total number of active users
+    """
+
+    client = BetaAnalyticsDataClient()
+
+    request = RunReportRequest(
+        property=f'properties/{property_id}',
+        dimensions=[],
+        metrics=[Metric(name='activeUsers')],
+        date_ranges=[DateRange(start_date='2020-03-31', end_date='today')],
+    )
+
+    response = client.run_report(request)
+
+    total_users = 0
+    for row in response.rows:
+        total_users += int(row.metric_values[0].value)
+
+    return total_users
+
+
+def get_metrics(portal_id, foundations_id, cookbooks_id):
+    """Retrieves total users for specified GA4 properties and writes to file if changes are significant."""
+
+    metrics_dict = {}
+    metrics_dict['Portal'] = _run_total_users_report(str(portal_id))
+    metrics_dict['Foundations'] = _run_total_users_report(str(foundations_id))
+    metrics_dict['Cookbooks'] = _run_total_users_report(str(cookbooks_id))
+
+    return metrics_dict  # Return the metrics dictionary
+
+
+def write_metrics(metrics_dict):
+    """Reads existing metrics, compares for significant change, and writes to file if necessary."""
+
+    # Read existing user counts (handle potential file absence)
+    try:
+        with open('user_metrics.json') as f:
+            user_data = json.load(f)
+    except FileNotFoundError:
+        user_data = {}
+
+    # Define a threshold for significant change (adjust as needed)
+    threshold = 100
+    has_significant_change = False
+    for property, user_count in metrics_dict.items():
+        existing_count = user_data.get(property, 0)
+        if abs(existing_count - user_count) > threshold:
+            user_data[property] = user_count
+            has_significant_change = True
+
+    # Write to file if significant change detected
+    if has_significant_change:
+        with open('user_metrics.json', 'w') as outfile:
+            json.dump(metrics_dict, outfile)
+        return 1  # Signals significant change
+    else:
+        return 0  # Signals no significant change
+
+
+if __name__ == '__main__':
+    metrics = get_metrics(PORTAL_ID, FOUNDATIONS_ID, COOKBOOKS_ID)
+    exit_code = write_metrics(metrics)
+    if exit_code == 1:
+        print('Significant change detected in user metrics.')
+    else:
+        print('No significant change in user metrics.')

.github/workflows/user_metrics.json

@@ -0,0 +1 @@
+{"Portal": 0, "Foundations": 0, "Cookbooks": 0}

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

@@ -0,0 +1,33 @@
+import json
+
+
+def process_user_data(user_data_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.
+    """
+
+    with open(user_data_file, 'r') as f:
+        user_data = json.load(f)
+
+    # table_header = '| Portal | Foundations | Cookbooks |\n'
+    # table_row = f"| {' | '.join([str(user_data[key]) for key in user_data])} |\n"
+    # table = table_header + table_row
+
+    # Write processed data to markdown file
+    with open(markdown_file, 'w') as f:
+        f.write('# Metrics \n\n')
+        f.write('Total Users:\n\n')
+        for key in user_data:
+            f.write(f'{key}: {user_data[key]}\n')
+    f.close()
+
+
+if __name__ == '__main__':
+    user_data_file = 'user_metrics.json'
+    markdown_file = '../../portal/metrics.md'
+    process_user_data(user_data_file, markdown_file)
+    print('User data report generated: ', markdown_file)

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,7 @@
+# Metrics
+
+Total Users:
+
+Portal: 0
+Foundations: 0
+Cookbooks: 0