add 3rd plot type and edit fontsizes etc

Author: jukent

.github/workflows/get-metrics.py

@@ -1,8 +1,9 @@
+import datetime
 import json
-import math
 import os
 
 import cartopy
+import matplotlib
 import matplotlib.cm as cm
 import matplotlib.colors as colors
 import matplotlib.pyplot as plt
@@ -56,13 +57,55 @@ def _run_total_users_report(property_id):
 
 def get_total_users(PORTAL_ID, FOUNDATIONS_ID, COOKBOOKS_ID):
     metrics_dict = {}
+    metrics_dict['Now'] = str(datetime.datetime.now())
     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_active_users_this_year(property_id):
+    current_year = datetime.datetime.now().year
+    start_date = f'{current_year}-01-01'
+
+    request = RunReportRequest(
+        property=f'properties/{property_id}',
+        dimensions=[Dimension(name='date')],
+        metrics=[Metric(name='activeUsers')],
+        date_ranges=[DateRange(start_date=start_date, end_date='today')],
+    )
+    response = client.run_report(request)
+
+    dates = []
+    user_counts = []
+    for row in response.rows:
+        date_str = row.dimension_values[0].value
+        date = datetime.datetime.strptime(date_str, '%Y%m%d')
+        dates.append(date)
+        user_counts.append(int(row.metric_values[0].value))
+
+    return zip(*sorted(zip(dates, user_counts), key=lambda x: x[0]))
+
+
+def plot_projects_this_year(PORTAL_ID, FOUNDATIONS_ID, COOKBOOKS_ID):
+    portal_dates, portal_users = _run_active_users_this_year(PORTAL_ID)
+    foundations_dates, foundations_users = _run_active_users_this_year(FOUNDATIONS_ID)
+    cookbooks_dates, cookbooks_users = _run_active_users_this_year(COOKBOOKS_ID)
+
+    plt.figure(figsize=(10, 5.5))
+    plt.title('Year-to-Date Pythia Active Users', fontsize=15)
+
+    plt.plot(portal_dates, portal_users, color='purple', label='Portal')
+    plt.plot(foundations_dates, foundations_users, color='royalblue', label='Foundations')
+    plt.plot(cookbooks_dates, cookbooks_users, color='indianred', label='Cookbooks')
+
+    plt.legend(fontsize=12, loc='upper right')
+
+    plt.xlabel('Date', fontsize=12)
+    plt.savefig('portal/metrics/thisyear.png', bbox_inches='tight')
+
+
 def _run_top_pages_report(property_id):
     request = RunReportRequest(
         property=f'properties/{property_id}',
@@ -72,72 +115,56 @@ def _run_top_pages_report(property_id):
     )
     response = client.run_report(request)
 
-    page_views = {}
+    views_dict = {}
     for row in response.rows:
         page = row.dimension_values[0].value
         views = int(row.metric_values[0].value)
-        page_views[page] = views
-
-    top_10_pages = sorted(page_views.items(), key=lambda item: item[1], reverse=True)[:10]
-    return {page: views for page, views in top_10_pages}
-
-
-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)
-
-    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])}
-    foundations_views = foundations_sorted.values()
-    for key in foundations_sorted:
-        newkey = key.split('—')[0]
-        foundations_pages.append(newkey)
-
-    cookbooks_page_views = _run_top_pages_report(cookbooks_id)
-    cookbooks_pages = []
-    cookbooks_sorted = {k: v for k, v in sorted(cookbooks_page_views.items(), key=lambda item: item[1])}
-    cookbooks_views = cookbooks_sorted.values()
-    for key in cookbooks_page_views:
-        newkey = key.split('—')[0]
-        cookbooks_pages.insert(0, newkey)
+        views_dict[page] = views
 
-    pages = cookbooks_pages + foundations_pages + portal_pages
+    top_pages = sorted(views_dict.items(), key=lambda item: item[1], reverse=True)[:5]
+    pages = [page.split('—')[0] for page, _ in top_pages]
+    views = [views for _, views in top_pages]
+
+    return pages[::-1], views[::-1]
 
-    fig, ax = plt.subplots(figsize=(10, 8))
-    plt.title('All-Time Top Pages')
 
-    views_max = int(math.ceil(max(portal_views) / 10000.0)) * 10000
-    ax.set_xlim([0, views_max])
+def plot_top_pages(PORTAL_ID, FOUNDATIONS_ID, COOKBOOKS_ID):
+    portal_pages, portal_views = _run_top_pages_report(PORTAL_ID)
+    foundations_pages, foundations_views = _run_top_pages_report(FOUNDATIONS_ID)
+    cookbooks_pages, cookbooks_views = _run_top_pages_report(COOKBOOKS_ID)
 
-    y = np.arange(10)
-    y2 = np.arange(11, 21)
-    y3 = np.arange(22, 32)
+    pages = cookbooks_pages + foundations_pages + portal_pages
+
+    fig, ax = plt.subplots(figsize=(10, 5.5))
+    plt.title('All-Time Top Pages', fontsize=15)
+
+    y = np.arange(5)
+    y2 = np.arange(6, 11)
+    y3 = np.arange(12, 17)
     y4 = np.append(y, y2)
     y4 = np.append(y4, y3)
 
     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(y4, labels=pages)
+    ax.set_yticks(y4, labels=pages, fontsize=12)
+
+    ax.bar_label(bar1, fmt=_format_rounding, padding=5, fontsize=10)
+    ax.bar_label(bar2, fmt=_format_rounding, padding=5, fontsize=10)
+    ax.bar_label(bar3, fmt=_format_rounding, padding=5, fontsize=10)
 
-    ax.bar_label(bar1, fmt=_format_rounding)
-    ax.bar_label(bar2, fmt=_format_rounding)
-    ax.bar_label(bar3, fmt=_format_rounding)
+    ax.set_xscale('log')
+    ax.set_xlim([10, 10**5])
+    ax.set_xlabel('Page Views', fontsize=12)
 
-    plt.legend()
+    plt.legend(fontsize=12, loc='lower right')
     plt.savefig('portal/metrics/toppages.png', bbox_inches='tight')
 
 
-def _run_usersXcountry_report(foundations_id):
+def _run_usersXcountry_report(property_id):
     request = RunReportRequest(
-        property=f'properties/{foundations_id}',
+        property=f'properties/{property_id}',
         dimensions=[Dimension(name='country')],
         metrics=[Metric(name='activeUsers')],
         date_ranges=[DateRange(start_date='2020-03-31', end_date='today')],
@@ -153,8 +180,8 @@ def _run_usersXcountry_report(foundations_id):
     return user_by_country
 
 
-def plot_usersXcountry(foundations_id):
-    users_by_country = _run_usersXcountry_report(foundations_id)
+def plot_usersXcountry(FOUNDATIONS_ID):
+    users_by_country = _run_usersXcountry_report(FOUNDATIONS_ID)
 
     dict_api2cartopy = {
         'Tanzania': 'United Republic of Tanzania',
@@ -178,42 +205,49 @@ def plot_usersXcountry(foundations_id):
 
     fig = plt.figure(figsize=(10, 4))
     ax = plt.axes(projection=cartopy.crs.PlateCarree(), frameon=False)
-    ax.set_title('Pythia Foundations Unique Users by Country')
+    ax.set_title('Pythia Foundations Users by Country', fontsize=15)
 
     shapefile = cartopy.io.shapereader.natural_earth(category='cultural', resolution='110m', name='admin_0_countries')
     reader = cartopy.io.shapereader.Reader(shapefile)
     countries = reader.records()
 
     colormap = plt.get_cmap('Blues')
-    colormap.set_extremes(under='grey')
-    vmax = int(math.ceil(max(users_by_country.values()) / 100.0)) * 100
-    norm = colors.LogNorm(vmin=1, vmax=vmax)
-    mappable = cm.ScalarMappable(norm=norm, cmap=colormap)
+    newcmp = colors.ListedColormap(colormap(np.linspace(0.2, 1, 128)))
+    newcmp.set_extremes(under='grey')
+
+    norm = colors.LogNorm(vmin=1, vmax=max(users_by_country.values()))
+    mappable = cm.ScalarMappable(norm=norm, cmap=newcmp)
 
     for country in countries:
         country_name = country.attributes['SOVEREIGNT']
         if country_name in users_by_country.keys():
-            facecolor = colormap((users_by_country[country_name] / 105))
-
+            facecolor = newcmp(norm(users_by_country[country_name]))
             ax.add_geometries(
-                [country.geometry], cartopy.crs.PlateCarree(), facecolor=facecolor, edgecolor='white', linewidth=0.7
+                [country.geometry],
+                cartopy.crs.PlateCarree(),
+                facecolor=facecolor,
+                edgecolor='white',
+                linewidth=0.7,
+                norm=matplotlib.colors.LogNorm(),
             )
         else:
             ax.add_geometries(
                 [country.geometry], cartopy.crs.PlateCarree(), facecolor='grey', edgecolor='white', linewidth=0.7
             )
 
     cax = fig.add_axes([0.1, -0.015, 0.67, 0.03])
-    fig.colorbar(mappable=mappable, cax=cax, spacing='uniform', orientation='horizontal', extend='min')
+    cbar = fig.colorbar(mappable=mappable, cax=cax, spacing='uniform', orientation='horizontal', extend='min')
+    cbar.set_label('Unique Users')
 
     props = dict(boxstyle='round', facecolor='white', edgecolor='white')
-    ax.text(1.01, 0.5, top_10_text, transform=ax.transAxes, fontsize=9, verticalalignment='center', bbox=props)
+    ax.text(1.01, 0.5, top_10_text, transform=ax.transAxes, fontsize=12, verticalalignment='center', bbox=props)
 
     plt.tight_layout()
     plt.savefig('portal/metrics/bycountry.png', bbox_inches='tight')
 
 
 if __name__ == '__main__':
     get_total_users(PORTAL_ID, FOUNDATIONS_ID, COOKBOOKS_ID)
+    plot_projects_this_year(PORTAL_ID, FOUNDATIONS_ID, COOKBOOKS_ID)
     plot_top_pages(PORTAL_ID, FOUNDATIONS_ID, COOKBOOKS_ID)
-    plot_usersXcountry(str(FOUNDATIONS_ID))
+    plot_usersXcountry(FOUNDATIONS_ID)

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

@@ -1,16 +1,18 @@
-import datetime
 import json
 
 
-def process_user_data(json_file, top_pages, map, md_file):
+def process_user_data(json_file, top_pages, this_year, map, md_file):
     with open(json_file, 'r') as f:
         user_data = json.load(f)
 
     with open(md_file, 'w') as f:
         f.write('# Metrics \n\n')
-        f.write(f'Last Updated: {datetime.datetime.now()}\n\n')
+        now = user_data['Now']
+        f.write(f'Last Updated: {now}')
+        user_data.pop('Now')
+        f.write('\n\n')
 
-        headers = '| Project | Views |'
+        headers = '| Project | Users |'
         separator = '| ' + ' | '.join(['-----'] * 2) + ' |'
         rows = []
         for key in user_data.keys():
@@ -19,15 +21,17 @@ def process_user_data(json_file, top_pages, map, md_file):
         f.write(table)
         f.write('\n\n')
 
-        f.write(f'![Top Pages]({top_pages})')
-        f.write(f'![Users by Country]({map})')
-        f.write('\n')
+        f.write(f'![Top Pages]({top_pages})\n\n')
+        f.write(f'![Users this Year]({this_year})\n\n')
+        f.write(f'![Users by Country]({map})\n\n')
+
     f.close()
 
 
 if __name__ == '__main__':
     json_file = 'portal/metrics/user_metrics.json'
     top_pages = 'metrics/toppages.png'
+    this_year = 'metrics/thisyear.png'
     map = 'metrics/bycountry.png'
     md_file = 'portal/metrics.md'
-    process_user_data(json_file, top_pages, map, md_file)
+    process_user_data(json_file, top_pages, this_year, map, md_file)

portal/metrics.md

@@ -1,11 +1,15 @@
 # Metrics
 
-Last Updated: 2024-03-19 09:15:00.008673
+Last Updated: 2024-03-19 15:46:22.786326
 
-| Project | Views |
+| Project | Users |
 | ----- | ----- |
 | Portal | 12.3K |
-| Foundations | 47.0K |
+| Foundations | 47.1K |
 | Cookbooks | 6.2K |
 
-![Top Pages](metrics/toppages.png)![Users by Country](metrics/bycountry.png)
+![Top Pages](metrics/toppages.png)
+
+![Users this Year](metrics/thisyear.png)
+
+![Users by Country](metrics/bycountry.png)

portal/metrics/bycountry.png

@@ -1 +1 @@
-{"Portal": "12.3K", "Foundations": "47.0K", "Cookbooks": "6.2K"}
+{"Now": "2024-03-19 15:46:22.786326", "Portal": "12.3K", "Foundations": "47.1K", "Cookbooks": "6.2K"}