From 4926f7834bb9ad6375f2070063e180cda3f4113e Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 11:14:25 -0600 Subject: [PATCH 01/34] Create automate-metrics.yaml --- .github/workflows/automate-metrics.yaml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 .github/workflows/automate-metrics.yaml diff --git a/.github/workflows/automate-metrics.yaml b/.github/workflows/automate-metrics.yaml new file mode 100644 index 00000000..7f39bbff --- /dev/null +++ b/.github/workflows/automate-metrics.yaml @@ -0,0 +1,15 @@ +on: [push] + +jobs: + main: + runs-on: macos-latest + steps: + - uses: actions/checkout@v3 + - name: Install Flutter SDK + uses: mobiledevops/secret-to-file-action@v1 + with: + base64-encoded-secret: ${{ secrets.FILE_CONTENT }} + filename: "hello-world.sh" + is-executable: true + working-directory: "./a/b/c" + - run: ./a/b/c/hello-world.sh From 7b0acfab2da7719dc5dad0bf740182ca5582c584 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 11:31:30 -0600 Subject: [PATCH 02/34] outline for automate-metrics.yaml --- .github/workflows/automate-metrics.yaml | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/.github/workflows/automate-metrics.yaml b/.github/workflows/automate-metrics.yaml index 7f39bbff..5ae853c5 100644 --- a/.github/workflows/automate-metrics.yaml +++ b/.github/workflows/automate-metrics.yaml @@ -1,4 +1,7 @@ -on: [push] +on: + schedule: + # Weekly Every Monday at 1PM UTC + - cron: '0 13 * * 1' jobs: main: @@ -8,8 +11,21 @@ jobs: - name: Install Flutter SDK uses: mobiledevops/secret-to-file-action@v1 with: - base64-encoded-secret: ${{ secrets.FILE_CONTENT }} - filename: "hello-world.sh" + base64-encoded-secret: ${{ secrets.GOOGLE_ANALYTICS_API_CREDENTIALS }} + filename: "credentials.json" is-executable: true working-directory: "./a/b/c" - - run: ./a/b/c/hello-world.sh + - run: export GOOGLE_APPLICATION_CREDENTIALS="credentials.json" + + - name: Create Virtual Environment + - run: + python3 -m venv analytics-api + source analytics-api/bin/activate + pip install google-analytics-data + + - name: Get Credentials + - run: credentials.py + pass in 3 secrets for foundations, cookbook, and portal + + - name: Update Site + # run an if check to only open a PR if metrics have changed by a certain margin? From b8511a20d895f7ed1cd87a29e80b2aa07370741b Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 11:33:57 -0600 Subject: [PATCH 03/34] Create get-metrics.py --- .github/workflows/get-metrics.py | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/workflows/get-metrics.py diff --git a/.github/workflows/get-metrics.py b/.github/workflows/get-metrics.py new file mode 100644 index 00000000..2c995648 --- /dev/null +++ b/.github/workflows/get-metrics.py @@ -0,0 +1,22 @@ +from google.analytics.data_v1beta import BetaAnalyticsDataClient +from google.analytics.data_v1beta.types import ( + DateRange, + Metric, + RunReportRequest, +) + +def run_total_users_report(property_id): + 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 From a9ed412df11376fd20a203b16c36c19f9b0953d7 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 11:43:56 -0600 Subject: [PATCH 04/34] Update automate-metrics.yaml --- .github/workflows/automate-metrics.yaml | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/.github/workflows/automate-metrics.yaml b/.github/workflows/automate-metrics.yaml index 5ae853c5..0609d520 100644 --- a/.github/workflows/automate-metrics.yaml +++ b/.github/workflows/automate-metrics.yaml @@ -1,4 +1,4 @@ -on: +ion: schedule: # Weekly Every Monday at 1PM UTC - cron: '0 13 * * 1' @@ -23,9 +23,13 @@ jobs: source analytics-api/bin/activate pip install google-analytics-data - - name: Get Credentials - - run: credentials.py - pass in 3 secrets for foundations, cookbook, and portal + - name: Get Metrics + - run: + python + import get-metrics + portal = get-metrics.run_total_users_report(${{ secrets.GA4_PORTAL_ID }}) + foundations = get-metrics.run_total_users_report(${{ secrets.GA4_FOUNDATIONS_ID }}) + cookbooks = get-metrics.run_total_users_report(${{ secrets.GA4_COOKBOOKS_ID }}) - name: Update Site # run an if check to only open a PR if metrics have changed by a certain margin? From 37cd664d45124b6b1c372a9b664daa283d4c2aed Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 11:48:13 -0600 Subject: [PATCH 05/34] Update automate-metrics.yaml --- .github/workflows/automate-metrics.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/automate-metrics.yaml b/.github/workflows/automate-metrics.yaml index 0609d520..bee334af 100644 --- a/.github/workflows/automate-metrics.yaml +++ b/.github/workflows/automate-metrics.yaml @@ -14,7 +14,7 @@ jobs: base64-encoded-secret: ${{ secrets.GOOGLE_ANALYTICS_API_CREDENTIALS }} filename: "credentials.json" is-executable: true - working-directory: "./a/b/c" + working-directory: "." - run: export GOOGLE_APPLICATION_CREDENTIALS="credentials.json" - name: Create Virtual Environment From aa0463b77ee1606101a8ccbbaa74ad16aadc9bc0 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 12:01:43 -0600 Subject: [PATCH 06/34] Update footer-menu.html with metrics --- portal/_templates/footer-menu.html | 1 + 1 file changed, 1 insertion(+) diff --git a/portal/_templates/footer-menu.html b/portal/_templates/footer-menu.html index 3a17455b..73477ed8 100644 --- a/portal/_templates/footer-menu.html +++ b/portal/_templates/footer-menu.html @@ -8,6 +8,7 @@

{{ _("About") }}

  • {{ _("About Project Pythia") }}
  • {{ _("How to use Pythia Foundations") }}
  • {{ _("How to Cite") }}
    • +
  • {{ _("User Metrics") }}
    • From 8b91ca44ed6efe9dcefeb09049719652f673ca46 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 12:06:12 -0600 Subject: [PATCH 07/34] Create metrics.md --- portal/metrics.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 portal/metrics.md diff --git a/portal/metrics.md b/portal/metrics.md new file mode 100644 index 00000000..ff56d7d1 --- /dev/null +++ b/portal/metrics.md @@ -0,0 +1,9 @@ +# User Metrics + +Total Users: + +Portal: {{ jsonextract("../github/user_metrics.json", "$.portal") }} + +Foundations: {{ jsonextract("../github/user_metrics.json", "$.foundations") }} + +Cookbooks: {{ jsonextract("../github/user_metrics.json", "$.cookbooks") }} From 9f664fa6f16c5e3a9e0a9f5b3774a951baca2541 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 12:06:46 -0600 Subject: [PATCH 08/34] add json_extract to extensions --- portal/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/portal/conf.py b/portal/conf.py index 35ea2ef7..c3374273 100644 --- a/portal/conf.py +++ b/portal/conf.py @@ -37,6 +37,7 @@ 'resource_gallery_generator', 'ablog', 'sphinx.ext.intersphinx', + 'json_extract', ] # Define what extensions will parse which kind of source file From 2dafc212ee7a482d0b7dda4789bb71fbe1793955 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 12:39:44 -0600 Subject: [PATCH 09/34] Update get-metrics.py to also write file --- .github/workflows/get-metrics.py | 61 ++++++++++++++++++++++++++++++-- 1 file changed, 59 insertions(+), 2 deletions(-) diff --git a/.github/workflows/get-metrics.py b/.github/workflows/get-metrics.py index 2c995648..b0442542 100644 --- a/.github/workflows/get-metrics.py +++ b/.github/workflows/get-metrics.py @@ -4,8 +4,19 @@ Metric, RunReportRequest, ) +import json + + +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 + """ -def run_total_users_report(property_id): client = BetaAnalyticsDataClient() request = RunReportRequest( @@ -14,9 +25,55 @@ def run_total_users_report(property_id): 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(): + """Retrieves total users for all GA4 properties and stores them in a dictionary + + Returns: + dict: A dictionary containing property names as keys and user counts as values + """ + + metrics_dict = {} + metrics_dict["portal_users"] = run_total_users_report({{ secrets.GA4_PORTAL_ID }}) + metrics_dict["foundations_users"] = run_total_users_report({{ secrets.GA4_FOUNDATIONS_ID }}) + metrics_dict["cookbooks_users"] = run_total_users_report({{ secrets.GA4_COOKBOOKS_ID }}) + return metrics_dict + + +def write_metrics(): + """Retrieves metrics, checks for significant change, and writes to file. + """ + + metrics_dict = get_metrics() + + # Read existing user counts + try: + with open("user_metrics.json") as f: + user_data = json.load(f) + except FileNotFoundError: + user_data = {} # Handle case where file doesn't exist + + # Check for significant difference (configurable threshold) + threshold = 100 + has_significant_change = FALSE + for property, user_count in metrics_dict.items(): + if abs(existing_data.get(property, 0) - user_count) > threshold: + user_data[property] = user_count + has_significant_change = TRUE + if has_significant_change + with open("user_metrics.json", "w") as outfile: + json.dump(metrics_dict, outfile) + print(f"User count for {portal} has changed significantly. Updating user_metrics.json") + else: + print(f"User count for {portal} hasn't changed significantly. Skipping update.") + +write_metrics() From 47fad36ed8bd3707b9095c62c6320a971bc341a8 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 12:50:10 -0600 Subject: [PATCH 10/34] Update get-metrics.py with returned condition --- .github/workflows/get-metrics.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/get-metrics.py b/.github/workflows/get-metrics.py index b0442542..9d67a3cf 100644 --- a/.github/workflows/get-metrics.py +++ b/.github/workflows/get-metrics.py @@ -72,8 +72,8 @@ def write_metrics(): if has_significant_change with open("user_metrics.json", "w") as outfile: json.dump(metrics_dict, outfile) - print(f"User count for {portal} has changed significantly. Updating user_metrics.json") + return 1 else: - print(f"User count for {portal} hasn't changed significantly. Skipping update.") + return 0 write_metrics() From 9a4a65773957de2abe30a3e1693c3dc3caaf1920 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 12:55:44 -0600 Subject: [PATCH 11/34] Update automate-metrics.yaml --- .github/workflows/automate-metrics.yaml | 33 ++++++++++++++----------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/.github/workflows/automate-metrics.yaml b/.github/workflows/automate-metrics.yaml index bee334af..feed1cb4 100644 --- a/.github/workflows/automate-metrics.yaml +++ b/.github/workflows/automate-metrics.yaml @@ -1,14 +1,16 @@ -ion: +name: Update User Metrics + +on: schedule: # Weekly Every Monday at 1PM UTC - - cron: '0 13 * * 1' + - cron: '0 13 * * 1' jobs: main: runs-on: macos-latest steps: - uses: actions/checkout@v3 - - name: Install Flutter SDK + - name: Set Credentials uses: mobiledevops/secret-to-file-action@v1 with: base64-encoded-secret: ${{ secrets.GOOGLE_ANALYTICS_API_CREDENTIALS }} @@ -17,19 +19,20 @@ jobs: working-directory: "." - run: export GOOGLE_APPLICATION_CREDENTIALS="credentials.json" - - name: Create Virtual Environment - - run: - python3 -m venv analytics-api + - name: Set Up Virtual Environment + run: | + python -m venv analytics-api source analytics-api/bin/activate pip install google-analytics-data - - name: Get Metrics - - run: - python - import get-metrics - portal = get-metrics.run_total_users_report(${{ secrets.GA4_PORTAL_ID }}) - foundations = get-metrics.run_total_users_report(${{ secrets.GA4_FOUNDATIONS_ID }}) - cookbooks = get-metrics.run_total_users_report(${{ secrets.GA4_COOKBOOKS_ID }}) + - name: Get and Write Metrics + run: python get_metrics.py - - name: Update Site - # run an if check to only open a PR if metrics have changed by a certain margin? + - 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 commit -m "Update user metrics" + git push From f6dbf6df2fc4a7ab610c20f7273a69dba3c7f5e9 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 13:31:37 -0600 Subject: [PATCH 12/34] pre-commit --- .github/workflows/automate-metrics.yaml | 2 +- .github/workflows/get-metrics.py | 37 ++++++++++++------------- 2 files changed, 18 insertions(+), 21 deletions(-) diff --git a/.github/workflows/automate-metrics.yaml b/.github/workflows/automate-metrics.yaml index feed1cb4..8079ab43 100644 --- a/.github/workflows/automate-metrics.yaml +++ b/.github/workflows/automate-metrics.yaml @@ -19,7 +19,7 @@ jobs: working-directory: "." - run: export GOOGLE_APPLICATION_CREDENTIALS="credentials.json" - - name: Set Up Virtual Environment + - name: Set-Up Virtual Environment run: | python -m venv analytics-api source analytics-api/bin/activate diff --git a/.github/workflows/get-metrics.py b/.github/workflows/get-metrics.py index 9d67a3cf..12981279 100644 --- a/.github/workflows/get-metrics.py +++ b/.github/workflows/get-metrics.py @@ -1,13 +1,10 @@ -from google.analytics.data_v1beta import BetaAnalyticsDataClient -from google.analytics.data_v1beta.types import ( - DateRange, - Metric, - RunReportRequest, -) import json +from google.analytics.data_v1beta import BetaAnalyticsDataClient +from google.analytics.data_v1beta.types import DateRange, Metric, RunReportRequest + -def run_total_users_report(property_id): +def _run_total_users_report(property_id): """Fetches total users for a given property ID Args: @@ -22,8 +19,8 @@ def run_total_users_report(property_id): request = RunReportRequest( property=f"properties/{property_id}", dimensions=[], - metrics=[Metric(name="activeUsers")], - date_ranges=[DateRange(start_date="2020-03-31", end_date="today")], + metrics=[Metric(name='activeUsers')], + date_ranges=[DateRange(start_date='2020-03-31', end_date='today')], ) response = client.run_report(request) @@ -35,7 +32,7 @@ def run_total_users_report(property_id): return total_users -def get_metrics(): +def _get_metrics(): """Retrieves total users for all GA4 properties and stores them in a dictionary Returns: @@ -43,21 +40,20 @@ def get_metrics(): """ metrics_dict = {} - metrics_dict["portal_users"] = run_total_users_report({{ secrets.GA4_PORTAL_ID }}) - metrics_dict["foundations_users"] = run_total_users_report({{ secrets.GA4_FOUNDATIONS_ID }}) - metrics_dict["cookbooks_users"] = run_total_users_report({{ secrets.GA4_COOKBOOKS_ID }}) + metrics_dict['portal_users'] = _run_total_users_report({{secrets.GA4_PORTAL_ID}}) + metrics_dict['foundations_users'] = _run_total_users_report({{secrets.GA4_FOUNDATIONS_ID}}) + metrics_dict['cookbooks_users'] = _run_total_users_report({{secrets.GA4_COOKBOOKS_ID}}) return metrics_dict def write_metrics(): - """Retrieves metrics, checks for significant change, and writes to file. - """ + """Retrieves metrics, checks for significant change, and writes to file.""" - metrics_dict = get_metrics() + metrics_dict = _get_metrics() # Read existing user counts try: - with open("user_metrics.json") as f: + with open('user_metrics.json') as f: user_data = json.load(f) except FileNotFoundError: user_data = {} # Handle case where file doesn't exist @@ -66,14 +62,15 @@ def write_metrics(): threshold = 100 has_significant_change = FALSE for property, user_count in metrics_dict.items(): - if abs(existing_data.get(property, 0) - user_count) > threshold: + if abs(user_data.get(property, 0) - user_count) > threshold: user_data[property] = user_count has_significant_change = TRUE - if has_significant_change - with open("user_metrics.json", "w") as outfile: + if has_significant_change: + with open('user_metrics.json', 'w') as outfile: json.dump(metrics_dict, outfile) return 1 else: return 0 + write_metrics() From 238edf2215c344beca461b776fc7567208c8ea14 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 13:58:44 -0600 Subject: [PATCH 13/34] use os to access passed in keys --- .github/workflows/automate-metrics.yaml | 2 +- .github/workflows/get-metrics.py | 50 ++++++++++++++----------- 2 files changed, 29 insertions(+), 23 deletions(-) diff --git a/.github/workflows/automate-metrics.yaml b/.github/workflows/automate-metrics.yaml index 8079ab43..b041b5ef 100644 --- a/.github/workflows/automate-metrics.yaml +++ b/.github/workflows/automate-metrics.yaml @@ -26,7 +26,7 @@ jobs: pip install google-analytics-data - name: Get and Write Metrics - run: python get_metrics.py + run: python get_metrics.py ${{ secrets.GA_PORTAL_ID }} ${{ secrets.GA_FOUNDATIONS_ID }} ${{ secrets.GA_COOKBOOKS_ID }} - name: Push Changes if: steps.Get-and-Write-Metrics.outputs == 1 # Conditional step execution diff --git a/.github/workflows/get-metrics.py b/.github/workflows/get-metrics.py index 12981279..da2fc3e3 100644 --- a/.github/workflows/get-metrics.py +++ b/.github/workflows/get-metrics.py @@ -1,4 +1,5 @@ import json +import os from google.analytics.data_v1beta import BetaAnalyticsDataClient from google.analytics.data_v1beta.types import DateRange, Metric, RunReportRequest @@ -32,45 +33,50 @@ def _run_total_users_report(property_id): return total_users -def _get_metrics(): - """Retrieves total users for all GA4 properties and stores them in a dictionary - - Returns: - dict: A dictionary containing property names as keys and user counts as values - """ +def get_metrics(ga4_portal_id, ga4_foundations_id, ga4_cookbooks_id): + """Retrieves total users for specified GA4 properties and writes to file if changes are significant.""" metrics_dict = {} - metrics_dict['portal_users'] = _run_total_users_report({{secrets.GA4_PORTAL_ID}}) - metrics_dict['foundations_users'] = _run_total_users_report({{secrets.GA4_FOUNDATIONS_ID}}) - metrics_dict['cookbooks_users'] = _run_total_users_report({{secrets.GA4_COOKBOOKS_ID}}) - return metrics_dict + metrics_dict['portal_users'] = _run_total_users_report(ga4_portal_id) + metrics_dict['foundations_users'] = _run_total_users_report(ga4_foundations_id) + metrics_dict['cookbooks_users'] = _run_total_users_report(ga4_cookbooks_id) + return metrics_dict # Return the metrics dictionary -def write_metrics(): - """Retrieves metrics, checks for significant change, and writes to file.""" - metrics_dict = _get_metrics() +def write_metrics(metrics_dict): + """Reads existing metrics, compares for significant change, and writes to file if necessary.""" - # Read existing user counts + # 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 = {} # Handle case where file doesn't exist + user_data = {} - # Check for significant difference (configurable threshold) + # Define a threshold for significant change (adjust as needed) threshold = 100 - has_significant_change = FALSE + has_significant_change = False for property, user_count in metrics_dict.items(): - if abs(user_data.get(property, 0) - user_count) > threshold: + existing_count = user_data.get(property, 0) + if abs(existing_count - user_count) > threshold: user_data[property] = user_count - has_significant_change = TRUE + 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 + return 1 # Signal significant change (optional) else: - return 0 + return 0 # Signal no significant change (optional) -write_metrics() +# Example usage (assuming script is executed directly) +if __name__ == '__main__': + metrics = get_metrics(os.getenv('GA4_PORTAL_ID'), os.getenv('GA4_FOUNDATIONS_ID'), os.getenv('GA4_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.') From 314b93d92a89abe72f392a9faba52573961c3fbf Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 14:05:12 -0600 Subject: [PATCH 14/34] fix double quoted strings --- .github/workflows/get-metrics.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/get-metrics.py b/.github/workflows/get-metrics.py index da2fc3e3..fdf63767 100644 --- a/.github/workflows/get-metrics.py +++ b/.github/workflows/get-metrics.py @@ -18,7 +18,7 @@ def _run_total_users_report(property_id): client = BetaAnalyticsDataClient() request = RunReportRequest( - property=f"properties/{property_id}", + property=f'properties/{property_id}', dimensions=[], metrics=[Metric(name='activeUsers')], date_ranges=[DateRange(start_date='2020-03-31', end_date='today')], From ce7f60edb6f56e0ee8652e693c695911bcef226d Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 14:22:05 -0600 Subject: [PATCH 15/34] add jsonextract to environment.yml --- environment.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/environment.yml b/environment.yml index 9cbef3a9..9fbcc1a0 100644 --- a/environment.yml +++ b/environment.yml @@ -11,5 +11,6 @@ dependencies: - pre-commit - sphinx-panels - ablog +- sphinx-ext-jsonextract - pip: - sphinx-pythia-theme From 49ba11b9ffc6e4b1d02ce1b8ec60b45723e1c131 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 14:58:37 -0600 Subject: [PATCH 16/34] write metrics.md in a python file --- .github/workflows/automate-metrics.yaml | 7 +++++- .github/workflows/get-metrics.py | 1 - .github/workflows/write_metrics_md.py | 29 +++++++++++++++++++++++++ environment.yml | 1 - portal/metrics.md | 6 ++--- 5 files changed, 38 insertions(+), 6 deletions(-) create mode 100644 .github/workflows/write_metrics_md.py diff --git a/.github/workflows/automate-metrics.yaml b/.github/workflows/automate-metrics.yaml index b041b5ef..9ec495c9 100644 --- a/.github/workflows/automate-metrics.yaml +++ b/.github/workflows/automate-metrics.yaml @@ -25,14 +25,19 @@ jobs: source analytics-api/bin/activate pip install google-analytics-data - - name: Get and Write Metrics + - name: Get and Write Metrics to JSON + # similarly, could save generated graphs to update more visually appealing metrics run: python get_metrics.py ${{ secrets.GA_PORTAL_ID }} ${{ secrets.GA_FOUNDATIONS_ID }} ${{ secrets.GA_COOKBOOKS_ID }} + - 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 diff --git a/.github/workflows/get-metrics.py b/.github/workflows/get-metrics.py index fdf63767..1a74b1cf 100644 --- a/.github/workflows/get-metrics.py +++ b/.github/workflows/get-metrics.py @@ -72,7 +72,6 @@ def write_metrics(metrics_dict): return 0 # Signal no significant change (optional) -# Example usage (assuming script is executed directly) if __name__ == '__main__': metrics = get_metrics(os.getenv('GA4_PORTAL_ID'), os.getenv('GA4_FOUNDATIONS_ID'), os.getenv('GA4_COOKBOOKS_ID')) exit_code = write_metrics(metrics) diff --git a/.github/workflows/write_metrics_md.py b/.github/workflows/write_metrics_md.py new file mode 100644 index 00000000..fa9c12ec --- /dev/null +++ b/.github/workflows/write_metrics_md.py @@ -0,0 +1,29 @@ +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('# User Metrics \n\n') + f.write(table) + + +if __name__ == '__main__': + user_data_file = 'user_data.json' + markdown_file = '../portal/metrics.md' + process_user_data(user_data_file, markdown_file) + print('User data report generated: ', markdown_file) diff --git a/environment.yml b/environment.yml index 9fbcc1a0..9cbef3a9 100644 --- a/environment.yml +++ b/environment.yml @@ -11,6 +11,5 @@ dependencies: - pre-commit - sphinx-panels - ablog -- sphinx-ext-jsonextract - pip: - sphinx-pythia-theme diff --git a/portal/metrics.md b/portal/metrics.md index ff56d7d1..b46c0978 100644 --- a/portal/metrics.md +++ b/portal/metrics.md @@ -2,8 +2,8 @@ Total Users: -Portal: {{ jsonextract("../github/user_metrics.json", "$.portal") }} +Portal: 0 -Foundations: {{ jsonextract("../github/user_metrics.json", "$.foundations") }} +Foundations: 0 -Cookbooks: {{ jsonextract("../github/user_metrics.json", "$.cookbooks") }} +Cookbooks: 0 From 53c472c15a7f133eb91ea041643245956ececa14 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 14:58:56 -0600 Subject: [PATCH 17/34] rm from config --- portal/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/portal/conf.py b/portal/conf.py index c3374273..35ea2ef7 100644 --- a/portal/conf.py +++ b/portal/conf.py @@ -37,7 +37,6 @@ 'resource_gallery_generator', 'ablog', 'sphinx.ext.intersphinx', - 'json_extract', ] # Define what extensions will parse which kind of source file From 99143ecbb2cb95845a5f947ec2295dcc0134ae2f Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 15:19:48 -0600 Subject: [PATCH 18/34] use env files --- .github/workflows/automate-metrics.yaml | 8 ++++++-- .github/workflows/get-metrics.py | 14 +++++++++----- 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/.github/workflows/automate-metrics.yaml b/.github/workflows/automate-metrics.yaml index 9ec495c9..f9ed2f29 100644 --- a/.github/workflows/automate-metrics.yaml +++ b/.github/workflows/automate-metrics.yaml @@ -5,6 +5,11 @@ on: # 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 @@ -26,8 +31,7 @@ jobs: pip install google-analytics-data - name: Get and Write Metrics to JSON - # similarly, could save generated graphs to update more visually appealing metrics - run: python get_metrics.py ${{ secrets.GA_PORTAL_ID }} ${{ secrets.GA_FOUNDATIONS_ID }} ${{ secrets.GA_COOKBOOKS_ID }} + run: python get_metrics.py - name: Write Markdown File run: python write_metrics_md.py diff --git a/.github/workflows/get-metrics.py b/.github/workflows/get-metrics.py index 1a74b1cf..43dbca8a 100644 --- a/.github/workflows/get-metrics.py +++ b/.github/workflows/get-metrics.py @@ -4,6 +4,10 @@ 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 @@ -33,13 +37,13 @@ def _run_total_users_report(property_id): return total_users -def get_metrics(ga4_portal_id, ga4_foundations_id, ga4_cookbooks_id): +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_users'] = _run_total_users_report(ga4_portal_id) - metrics_dict['foundations_users'] = _run_total_users_report(ga4_foundations_id) - metrics_dict['cookbooks_users'] = _run_total_users_report(ga4_cookbooks_id) + metrics_dict['portal_users'] = _run_total_users_report(str(portal_id)) + metrics_dict['foundations_users'] = _run_total_users_report(str(foundations_id)) + metrics_dict['cookbooks_users'] = _run_total_users_report(str(cookbooks_id)) return metrics_dict # Return the metrics dictionary @@ -73,7 +77,7 @@ def write_metrics(metrics_dict): if __name__ == '__main__': - metrics = get_metrics(os.getenv('GA4_PORTAL_ID'), os.getenv('GA4_FOUNDATIONS_ID'), os.getenv('GA4_COOKBOOKS_ID')) + 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.') From 7da60276742f3c579f1fe0c00aa1d356f531e540 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 15:20:39 -0600 Subject: [PATCH 19/34] update comment --- .github/workflows/get-metrics.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/get-metrics.py b/.github/workflows/get-metrics.py index 43dbca8a..4848f0d9 100644 --- a/.github/workflows/get-metrics.py +++ b/.github/workflows/get-metrics.py @@ -71,9 +71,9 @@ def write_metrics(metrics_dict): if has_significant_change: with open('user_metrics.json', 'w') as outfile: json.dump(metrics_dict, outfile) - return 1 # Signal significant change (optional) + return 1 # Signals significant change else: - return 0 # Signal no significant change (optional) + return 0 # Signals no significant change if __name__ == '__main__': From e15d349bee59443311f5f5cb0c6bccb5fd5cef1c Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 15:28:59 -0600 Subject: [PATCH 20/34] state with a table --- .github/workflows/write_metrics_md.py | 3 ++- portal/_templates/footer-menu.html | 2 +- portal/metrics.md | 10 +++------- 3 files changed, 6 insertions(+), 9 deletions(-) diff --git a/.github/workflows/write_metrics_md.py b/.github/workflows/write_metrics_md.py index fa9c12ec..6a848a29 100644 --- a/.github/workflows/write_metrics_md.py +++ b/.github/workflows/write_metrics_md.py @@ -18,7 +18,8 @@ def process_user_data(user_data_file, markdown_file): table = table_header + table_row # Write processed data to markdown file with open(markdown_file, 'w') as f: - f.write('# User Metrics \n\n') + f.write('# Metrics \n\n') + f.write('Total Users:\n') f.write(table) diff --git a/portal/_templates/footer-menu.html b/portal/_templates/footer-menu.html index 73477ed8..919cc9c3 100644 --- a/portal/_templates/footer-menu.html +++ b/portal/_templates/footer-menu.html @@ -8,7 +8,7 @@

    {{ _("About") }}

  • {{ _("About Project Pythia") }}
  • {{ _("How to use Pythia Foundations") }}
  • {{ _("How to Cite") }}
    • -
  • {{ _("User Metrics") }}
    • +
  • {{ _("Metrics") }}
    • diff --git a/portal/metrics.md b/portal/metrics.md index b46c0978..6ed0dc02 100644 --- a/portal/metrics.md +++ b/portal/metrics.md @@ -1,9 +1,5 @@ -# User Metrics +# Metrics Total Users: - -Portal: 0 - -Foundations: 0 - -Cookbooks: 0 +| Portal | Foundations | Cookbooks |\n +| 0 | 0 | 0 | \ No newline at end of file From 1d7c268df686cbaf9f2d2ed7c3eb6696f3aa6778 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 11 Mar 2024 21:29:13 +0000 Subject: [PATCH 21/34] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- portal/metrics.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/portal/metrics.md b/portal/metrics.md index 6ed0dc02..4099f6fe 100644 --- a/portal/metrics.md +++ b/portal/metrics.md @@ -2,4 +2,4 @@ Total Users: | Portal | Foundations | Cookbooks |\n -| 0 | 0 | 0 | \ No newline at end of file +| 0 | 0 | 0 | From 6e55f19e07758dae2283c9d402b333ba1fc44537 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 15:47:37 -0600 Subject: [PATCH 22/34] rm table because it won't format and add to toc tree --- .github/workflows/get-metrics.py | 6 +++--- .github/workflows/write_metrics_md.py | 13 ++++++++----- portal/index.md | 1 + portal/metrics.md | 8 ++++++-- 4 files changed, 18 insertions(+), 10 deletions(-) diff --git a/.github/workflows/get-metrics.py b/.github/workflows/get-metrics.py index 4848f0d9..2e74be38 100644 --- a/.github/workflows/get-metrics.py +++ b/.github/workflows/get-metrics.py @@ -41,9 +41,9 @@ 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_users'] = _run_total_users_report(str(portal_id)) - metrics_dict['foundations_users'] = _run_total_users_report(str(foundations_id)) - metrics_dict['cookbooks_users'] = _run_total_users_report(str(cookbooks_id)) + 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 diff --git a/.github/workflows/write_metrics_md.py b/.github/workflows/write_metrics_md.py index 6a848a29..b53179e8 100644 --- a/.github/workflows/write_metrics_md.py +++ b/.github/workflows/write_metrics_md.py @@ -13,14 +13,17 @@ def process_user_data(user_data_file, 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 + # 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') - f.write(table) + f.write('Total Users:\n\n') + for key in user_data: + f.write(f'{key}: {user_data[key]}') + f.close() if __name__ == '__main__': diff --git a/portal/index.md b/portal/index.md index a85cf984..54f0efd4 100644 --- a/portal/index.md +++ b/portal/index.md @@ -227,4 +227,5 @@ contributing.md code_of_conduct.md cookbook-gallery.md resource-gallery.md +metrics.md ``` diff --git a/portal/metrics.md b/portal/metrics.md index 6ed0dc02..05d732f3 100644 --- a/portal/metrics.md +++ b/portal/metrics.md @@ -1,5 +1,9 @@ # Metrics Total Users: -| Portal | Foundations | Cookbooks |\n -| 0 | 0 | 0 | \ No newline at end of file + +Portal: 0 + +Foundations: 0 + +Cookbooks: 0 From 99f8acf041dcbb85cecc874712883af860b554bd Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 16:06:17 -0600 Subject: [PATCH 23/34] add dispatch --- .github/workflows/automate-metrics.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/automate-metrics.yaml b/.github/workflows/automate-metrics.yaml index f9ed2f29..59d64914 100644 --- a/.github/workflows/automate-metrics.yaml +++ b/.github/workflows/automate-metrics.yaml @@ -1,6 +1,7 @@ name: Update User Metrics on: + workflow_dispatch: schedule: # Weekly Every Monday at 1PM UTC - cron: '0 13 * * 1' From ac5d69e1242270babd4cf2d11a1a1cea8d9cc70d Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 16:27:00 -0600 Subject: [PATCH 24/34] starting metrics file, and - vs _ --- .github/workflows/automate-metrics.yaml | 4 ++-- .github/workflows/user_metrics.json | 1 + .../workflows/{write_metrics_md.py => write-metrics-md.py} | 0 3 files changed, 3 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/user_metrics.json rename .github/workflows/{write_metrics_md.py => write-metrics-md.py} (100%) diff --git a/.github/workflows/automate-metrics.yaml b/.github/workflows/automate-metrics.yaml index 59d64914..58c291f7 100644 --- a/.github/workflows/automate-metrics.yaml +++ b/.github/workflows/automate-metrics.yaml @@ -32,10 +32,10 @@ jobs: pip install google-analytics-data - name: Get and Write Metrics to JSON - run: python get_metrics.py + run: python get-metrics.py - name: Write Markdown File - run: python write_metrics_md.py + run: python write-metrics-md.py - name: Push Changes if: steps.Get-and-Write-Metrics.outputs == 1 # Conditional step execution diff --git a/.github/workflows/user_metrics.json b/.github/workflows/user_metrics.json new file mode 100644 index 00000000..1d4472df --- /dev/null +++ b/.github/workflows/user_metrics.json @@ -0,0 +1 @@ +{"Portal": 0, "Foundations": 0, "Cookbooks": 0} \ No newline at end of file diff --git a/.github/workflows/write_metrics_md.py b/.github/workflows/write-metrics-md.py similarity index 100% rename from .github/workflows/write_metrics_md.py rename to .github/workflows/write-metrics-md.py From 2345bb098582cdab857c0536b62d735f197bdd25 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 16:33:59 -0600 Subject: [PATCH 25/34] pre-commit --- .github/workflows/user_metrics.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/user_metrics.json b/.github/workflows/user_metrics.json index 1d4472df..bc0b98e3 100644 --- a/.github/workflows/user_metrics.json +++ b/.github/workflows/user_metrics.json @@ -1 +1 @@ -{"Portal": 0, "Foundations": 0, "Cookbooks": 0} \ No newline at end of file +{"Portal": 0, "Foundations": 0, "Cookbooks": 0} From fc92d94b845662f480bd113839512625083d50e1 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Mon, 11 Mar 2024 16:39:24 -0600 Subject: [PATCH 26/34] fix write-metrics --- .github/workflows/write-metrics-md.py | 6 +++--- portal/metrics.md | 2 -- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/.github/workflows/write-metrics-md.py b/.github/workflows/write-metrics-md.py index b53179e8..63fe11a2 100644 --- a/.github/workflows/write-metrics-md.py +++ b/.github/workflows/write-metrics-md.py @@ -22,12 +22,12 @@ def process_user_data(user_data_file, markdown_file): f.write('# Metrics \n\n') f.write('Total Users:\n\n') for key in user_data: - f.write(f'{key}: {user_data[key]}') + f.write(f'{key}: {user_data[key]}\n') f.close() if __name__ == '__main__': - user_data_file = 'user_data.json' - markdown_file = '../portal/metrics.md' + 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) diff --git a/portal/metrics.md b/portal/metrics.md index 05d732f3..a4c0e8a6 100644 --- a/portal/metrics.md +++ b/portal/metrics.md @@ -3,7 +3,5 @@ Total Users: Portal: 0 - Foundations: 0 - Cookbooks: 0 From 4a18be6b016aaae95ff0224591c745023f4a2585 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Tue, 12 Mar 2024 09:12:21 -0600 Subject: [PATCH 27/34] make a metrics folder for holding future graphs --- .github/workflows/get-metrics.py | 4 ++-- .github/workflows/write-metrics-md.py | 2 +- {.github/workflows => metrics}/user_metrics.json | 0 3 files changed, 3 insertions(+), 3 deletions(-) rename {.github/workflows => metrics}/user_metrics.json (100%) diff --git a/.github/workflows/get-metrics.py b/.github/workflows/get-metrics.py index 2e74be38..3dac38ce 100644 --- a/.github/workflows/get-metrics.py +++ b/.github/workflows/get-metrics.py @@ -53,7 +53,7 @@ def write_metrics(metrics_dict): # Read existing user counts (handle potential file absence) try: - with open('user_metrics.json') as f: + with open('../../metrics/user_metrics.json') as f: user_data = json.load(f) except FileNotFoundError: user_data = {} @@ -69,7 +69,7 @@ def write_metrics(metrics_dict): # Write to file if significant change detected if has_significant_change: - with open('user_metrics.json', 'w') as outfile: + with open('../../metrics/user_metrics.json', 'w') as outfile: json.dump(metrics_dict, outfile) return 1 # Signals significant change else: diff --git a/.github/workflows/write-metrics-md.py b/.github/workflows/write-metrics-md.py index 63fe11a2..5f389963 100644 --- a/.github/workflows/write-metrics-md.py +++ b/.github/workflows/write-metrics-md.py @@ -27,7 +27,7 @@ def process_user_data(user_data_file, markdown_file): if __name__ == '__main__': - user_data_file = 'user_metrics.json' + user_data_file = '../../metrics/user_metrics.json' markdown_file = '../../portal/metrics.md' process_user_data(user_data_file, markdown_file) print('User data report generated: ', markdown_file) diff --git a/.github/workflows/user_metrics.json b/metrics/user_metrics.json similarity index 100% rename from .github/workflows/user_metrics.json rename to metrics/user_metrics.json From 5c449f08a93acd17a29450ac4307d988b52861d0 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Tue, 12 Mar 2024 09:18:38 -0600 Subject: [PATCH 28/34] missed a path herr --- .github/workflows/automate-metrics.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/automate-metrics.yaml b/.github/workflows/automate-metrics.yaml index 58c291f7..42fd00ba 100644 --- a/.github/workflows/automate-metrics.yaml +++ b/.github/workflows/automate-metrics.yaml @@ -42,7 +42,7 @@ jobs: 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 ../../metrics/user_metrics.json git add ../portal/metrics.md git commit -m "Update user metrics" git push From ed3a388edb484057f5a5f2b1b899c668740317e9 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Tue, 12 Mar 2024 14:05:41 -0600 Subject: [PATCH 29/34] add metrics automation as a step before site building --- .github/workflows/automate-metrics.yaml | 10 ----- .github/workflows/get-metrics.py | 48 ++--------------------- .github/workflows/nightly-build.yaml | 10 +++++ .github/workflows/publish-site.yaml | 3 ++ .github/workflows/trigger-site-build.yaml | 3 ++ .github/workflows/write-metrics-md.py | 7 +--- metrics/user_metrics.json | 1 - 7 files changed, 20 insertions(+), 62 deletions(-) delete mode 100644 metrics/user_metrics.json diff --git a/.github/workflows/automate-metrics.yaml b/.github/workflows/automate-metrics.yaml index 42fd00ba..6bfa4121 100644 --- a/.github/workflows/automate-metrics.yaml +++ b/.github/workflows/automate-metrics.yaml @@ -36,13 +36,3 @@ jobs: - 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 ../../metrics/user_metrics.json - git add ../portal/metrics.md - git commit -m "Update user metrics" - git push diff --git a/.github/workflows/get-metrics.py b/.github/workflows/get-metrics.py index 3dac38ce..32ed0d8e 100644 --- a/.github/workflows/get-metrics.py +++ b/.github/workflows/get-metrics.py @@ -10,14 +10,6 @@ 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() @@ -38,48 +30,14 @@ def _run_total_users_report(property_id): 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('../../metrics/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('../../metrics/user_metrics.json', 'w') as outfile: - json.dump(metrics_dict, outfile) - return 1 # Signals significant change - else: - return 0 # Signals no significant change + with open('user_metrics.json', 'w') as outfile: + json.dump(metrics_dict, outfile) 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.') + get_metrics(PORTAL_ID, FOUNDATIONS_ID, COOKBOOKS_ID) diff --git a/.github/workflows/nightly-build.yaml b/.github/workflows/nightly-build.yaml index f2ab7753..4fe75d41 100644 --- a/.github/workflows/nightly-build.yaml +++ b/.github/workflows/nightly-build.yaml @@ -6,6 +6,9 @@ on: - cron: '0 0 * * *' # Daily “At 00:00” jobs: + update-metrics: + uses: automate-metrics.yaml@main + build: if: ${{ github.repository_owner == 'ProjectPythia' }} uses: ProjectPythia/cookbook-actions/.github/workflows/build-book.yaml@main @@ -20,3 +23,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' diff --git a/.github/workflows/publish-site.yaml b/.github/workflows/publish-site.yaml index a8cd22f3..1d52a773 100644 --- a/.github/workflows/publish-site.yaml +++ b/.github/workflows/publish-site.yaml @@ -8,6 +8,9 @@ on: workflow_dispatch: jobs: + update-metrics: + uses: automate-metrics.yaml@main + build: uses: ProjectPythia/cookbook-actions/.github/workflows/build-book.yaml@main with: diff --git a/.github/workflows/trigger-site-build.yaml b/.github/workflows/trigger-site-build.yaml index ed8488cd..03363aaf 100644 --- a/.github/workflows/trigger-site-build.yaml +++ b/.github/workflows/trigger-site-build.yaml @@ -3,6 +3,9 @@ on: pull_request: jobs: + update-metrics: + uses: automate-metrics.yaml@main + build: uses: ProjectPythia/cookbook-actions/.github/workflows/build-book.yaml@main with: diff --git a/.github/workflows/write-metrics-md.py b/.github/workflows/write-metrics-md.py index 5f389963..c6fc6d70 100644 --- a/.github/workflows/write-metrics-md.py +++ b/.github/workflows/write-metrics-md.py @@ -13,10 +13,6 @@ def process_user_data(user_data_file, 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') @@ -27,7 +23,6 @@ def process_user_data(user_data_file, markdown_file): if __name__ == '__main__': - user_data_file = '../../metrics/user_metrics.json' + 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) diff --git a/metrics/user_metrics.json b/metrics/user_metrics.json deleted file mode 100644 index bc0b98e3..00000000 --- a/metrics/user_metrics.json +++ /dev/null @@ -1 +0,0 @@ -{"Portal": 0, "Foundations": 0, "Cookbooks": 0} From 820b976077a9a1596233da7686e6b849bd8ac1f0 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Tue, 12 Mar 2024 14:07:57 -0600 Subject: [PATCH 30/34] rm automate-metrics schedule --- .github/workflows/automate-metrics.yaml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/workflows/automate-metrics.yaml b/.github/workflows/automate-metrics.yaml index 6bfa4121..bce1f10e 100644 --- a/.github/workflows/automate-metrics.yaml +++ b/.github/workflows/automate-metrics.yaml @@ -2,9 +2,6 @@ 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 }} From 546fec2c315ae4c50d73d8c00c0e2d32dfce8ed0 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Tue, 12 Mar 2024 14:14:43 -0600 Subject: [PATCH 31/34] Add last updated time to write-metrics --- .github/workflows/write-metrics-md.py | 5 ++++- portal/metrics.md | 6 ------ 2 files changed, 4 insertions(+), 7 deletions(-) diff --git a/.github/workflows/write-metrics-md.py b/.github/workflows/write-metrics-md.py index c6fc6d70..1099ec31 100644 --- a/.github/workflows/write-metrics-md.py +++ b/.github/workflows/write-metrics-md.py @@ -1,5 +1,5 @@ import json - +import datetime def process_user_data(user_data_file, markdown_file): """ @@ -9,6 +9,7 @@ def process_user_data(user_data_file, markdown_file): 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) @@ -19,6 +20,8 @@ def process_user_data(user_data_file, markdown_file): f.write('Total Users:\n\n') for key in user_data: f.write(f'{key}: {user_data[key]}\n') + f.write('\n') + f.write(f'Last Updated: {now}\n') f.close() diff --git a/portal/metrics.md b/portal/metrics.md index a4c0e8a6..b05321b8 100644 --- a/portal/metrics.md +++ b/portal/metrics.md @@ -1,7 +1 @@ # Metrics - -Total Users: - -Portal: 0 -Foundations: 0 -Cookbooks: 0 From 411e54dbd46b55a8118f44028c958d1ece67ffbc Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Wed, 13 Mar 2024 11:21:47 -0600 Subject: [PATCH 32/34] pre-commit --- .github/workflows/write-metrics-md.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/write-metrics-md.py b/.github/workflows/write-metrics-md.py index 1099ec31..7c4c5082 100644 --- a/.github/workflows/write-metrics-md.py +++ b/.github/workflows/write-metrics-md.py @@ -1,5 +1,6 @@ -import json import datetime +import json + def process_user_data(user_data_file, markdown_file): """ From a907dffc62811dcd0ffcb152630e7b61b8413f95 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Fri, 15 Mar 2024 11:32:24 -0600 Subject: [PATCH 33/34] use curl --- .github/workflows/automate-metrics.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/automate-metrics.yaml b/.github/workflows/automate-metrics.yaml index bce1f10e..cc6fe279 100644 --- a/.github/workflows/automate-metrics.yaml +++ b/.github/workflows/automate-metrics.yaml @@ -29,7 +29,9 @@ jobs: pip install google-analytics-data - name: Get and Write Metrics to JSON - run: python get-metrics.py + run: | + curl -O https://raw.githubusercontent.com/jukent/projectpythia.github.io/metrics-api/.github/workflows/get-metrics.py + python get_metrics.py - name: Write Markdown File run: python write-metrics-md.py From f36f4b20864363f46d9efa60fe951d4cc532060a Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 15 Mar 2024 17:36:43 +0000 Subject: [PATCH 34/34] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .github/workflows/get-metrics.py | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/get-metrics.py b/.github/workflows/get-metrics.py index 3a531632..32ed0d8e 100644 --- a/.github/workflows/get-metrics.py +++ b/.github/workflows/get-metrics.py @@ -38,5 +38,6 @@ def get_metrics(portal_id, foundations_id, cookbooks_id): with open('user_metrics.json', 'w') as outfile: json.dump(metrics_dict, outfile) + if __name__ == '__main__': get_metrics(PORTAL_ID, FOUNDATIONS_ID, COOKBOOKS_ID)