format md table, add portal to top pages plot

Author: jukent

.github/workflows/get-metrics.py

@@ -3,7 +3,6 @@
 import os
 
 import cartopy
-import google
 import matplotlib.cm as cm
 import matplotlib.colors as colors
 import matplotlib.pyplot as plt
@@ -32,28 +31,20 @@
     'universe_domain': 'googleapis.com',
 }
 
-# with open('cisl-vast-pythia-606cf5ac2303.json') as json_file:
-#     credentials_dict = json.load(json_file)
-
-try:
-    client = BetaAnalyticsDataClient.from_service_account_info(credentials_dict)
-except google.auth.exceptions.MalformedError as e:
-    print('Malformed Error:', e)
-    print(len(PRIVATE_KEY))
+client = BetaAnalyticsDataClient.from_service_account_info(credentials_dict)
 
 
 def _format_rounding(value):
     return f'{round(value / 1000, 1):.1f}K'
 
 
-def run_total_users_report(property_id):
+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')],
     )
-
     response = client.run_report(request)
 
     total_users = 0
@@ -63,14 +54,22 @@ def run_total_users_report(property_id):
     return _format_rounding(total_users)
 
 
+def get_total_users(PORTAL_ID, FOUNDATIONS_ID, COOKBOOKS_ID):
+    metrics_dict = {}
+    metrics_dict['Portal'] = _run_total_users_report(PORTAL_ID)
+    metrics_dict['Foundations'] = _run_total_users_report(FOUNDATIONS_ID)
+    metrics_dict['Cookbooks'] = _run_total_users_report(COOKBOOKS_ID)
+    with open('portal/metrics/user_metrics.json', 'w') as outfile:
+        json.dump(metrics_dict, outfile)
+
+
 def _run_top_pages_report(property_id):
     request = RunReportRequest(
         property=f'properties/{property_id}',
         dimensions=[Dimension(name='pageTitle')],
         date_ranges=[DateRange(start_date='2020-03-31', end_date='today')],
         metrics=[Metric(name='screenPageViews')],
     )
-
     response = client.run_report(request)
 
     page_views = {}
@@ -80,12 +79,18 @@ def _run_top_pages_report(property_id):
         page_views[page] = views
 
     top_10_pages = sorted(page_views.items(), key=lambda item: item[1], reverse=True)[:10]
-    top_10_pages_dict = {page: views for page, views in top_10_pages}
+    return {page: views for page, views in top_10_pages}
 
-    return top_10_pages_dict
 
+def plot_top_pages(portal_id, foundations_id, cookbooks_id):
+    portal_page_views = _run_top_pages_report(portal_id)
+    portal_pages = []
+    portal_sorted = {k: v for k, v in sorted(portal_page_views.items(), key=lambda item: item[1])}
+    portal_views = portal_sorted.values()
+    for key in portal_sorted:
+        newkey = key.split('—')[0]
+        portal_pages.append(newkey)
 
-def plot_top_pages(foundations_id, cookbooks_id):
     foundations_page_views = _run_top_pages_report(foundations_id)
     foundations_pages = []
     foundations_sorted = {k: v for k, v in sorted(foundations_page_views.items(), key=lambda item: item[1])}
@@ -102,28 +107,32 @@ def plot_top_pages(foundations_id, cookbooks_id):
         newkey = key.split('—')[0]
         cookbooks_pages.insert(0, newkey)
 
-    pages = cookbooks_pages + foundations_pages
+    pages = cookbooks_pages + foundations_pages + portal_pages
 
-    fig, ax = plt.subplots()
-    plt.title('Most Popular Pages')
+    fig, ax = plt.subplots(figsize=(10, 8))
+    plt.title('All-Time Top Pages')
 
-    views_max = int(math.ceil(max(foundations_views) / 10000.0)) * 10000
+    views_max = int(math.ceil(max(portal_views) / 10000.0)) * 10000
     ax.set_xlim([0, views_max])
 
     y = np.arange(10)
     y2 = np.arange(11, 21)
-    y3 = np.append(y, y2)
+    y3 = np.arange(22, 32)
+    y4 = np.append(y, y2)
+    y4 = np.append(y4, y3)
 
-    bar1 = ax.barh(y2, foundations_views, align='center', label='Foundations', color='royalblue')
-    bar2 = ax.barh(y, cookbooks_views, align='center', label='Cookbooks', color='indianred')
+    bar1 = ax.barh(y3, portal_views, align='center', label='Portal', color='purple')
+    bar2 = ax.barh(y2, foundations_views, align='center', label='Foundations', color='royalblue')
+    bar3 = ax.barh(y, cookbooks_views, align='center', label='Cookbooks', color='indianred')
 
-    ax.set_yticks(y3, labels=pages)
+    ax.set_yticks(y4, labels=pages)
 
     ax.bar_label(bar1, fmt=_format_rounding)
     ax.bar_label(bar2, fmt=_format_rounding)
+    ax.bar_label(bar3, fmt=_format_rounding)
 
     plt.legend()
-    plt.savefig('portal/metrics/bypage.png', bbox_inches='tight')
+    plt.savefig('portal/metrics/toppages.png', bbox_inches='tight')
 
 
 def _run_usersXcountry_report(foundations_id):
@@ -133,7 +142,6 @@ def _run_usersXcountry_report(foundations_id):
         metrics=[Metric(name='activeUsers')],
         date_ranges=[DateRange(start_date='2020-03-31', end_date='today')],
     )
-
     response = client.run_report(request)
 
     user_by_country = {}
@@ -205,18 +213,7 @@ def plot_usersXcountry(foundations_id):
     plt.savefig('portal/metrics/bycountry.png', bbox_inches='tight')
 
 
-def get_metrics():
-    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))
-    with open('portal/metrics/user_metrics.json', 'w') as outfile:
-        json.dump(metrics_dict, outfile)
-
-    plot_top_pages(str(FOUNDATIONS_ID), str(COOKBOOKS_ID))
-
-    plot_usersXcountry(str(FOUNDATIONS_ID))
-
-
 if __name__ == '__main__':
-    get_metrics()
+    get_total_users(PORTAL_ID, FOUNDATIONS_ID, COOKBOOKS_ID)
+    plot_top_pages(PORTAL_ID, FOUNDATIONS_ID, COOKBOOKS_ID)
+    plot_usersXcountry(str(FOUNDATIONS_ID))

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

@@ -2,37 +2,32 @@
 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:
+def process_user_data(json_file, top_pages, map, md_file):
+    with open(json_file, 'r') as f:
         user_data = json.load(f)
 
-    # Write processed data to markdown file
-    with open(markdown_file, 'w') as f:
+    with open(md_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(f'![Top Pages]({bar_plot_file})')
+        f.write(f'Last Updated: {datetime.datetime.now()}\n\n')
+
+        headers = '| Project | Views |'
+        separator = '| ' + ' | '.join(['-----'] * 2) + ' |'
+        rows = []
+        for key in user_data.keys():
+            rows.append('| ' + key + ' | ' + user_data[key] + ' |')
+        table = '\n'.join([headers, separator] + rows)
+        f.write(table)
         f.write('\n\n')
-        f.write(f'![Users by Country]({map_plot_file})')
+
+        f.write(f'![Top Pages]({top_pages})')
+        f.write(f'![Users by Country]({map})')
         f.write('\n')
     f.close()
 
 
 if __name__ == '__main__':
-    user_data_file = 'portal/metrics/user_metrics.json'
-    bar_plot_file = 'metrics/bypage.png'
-    map_plot_file = 'metrics/bycountry.png'
-    markdown_file = 'portal/metrics.md'
-    process_user_data(user_data_file, bar_plot_file, map_plot_file, markdown_file)
+    json_file = 'portal/metrics/user_metrics.json'
+    top_pages = 'metrics/toppages.png'
+    map = 'metrics/bycountry.png'
+    md_file = 'portal/metrics.md'
+    process_user_data(json_file, top_pages, map, md_file)

portal/metrics.md

@@ -1,13 +1,11 @@
 # Metrics
 
-Last Updated: 2024-03-18 22:35:09.405196
+Last Updated: 2024-03-19 09:15:00.008673
 
-Total Users:
+| Project | Views |
+| ----- | ----- |
+| Portal | 12.3K |
+| Foundations | 47.0K |
+| Cookbooks | 6.2K |
 
-Portal: 46.9K
-Foundations: 46.9K
-Cookbooks: 6.2K
-
-![Top Pages](metrics/bypage.png)
-
-![Users by Country](metrics/bycountry.png)
+![Top Pages](metrics/toppages.png)![Users by Country](metrics/bycountry.png)

portal/metrics/bycountry.png

@@ -1 +1 @@
-{"Portal": "46.9K", "Foundations": "46.9K", "Cookbooks": "6.2K"}
+{"Portal": "12.3K", "Foundations": "47.0K", "Cookbooks": "6.2K"}