add custom metrics to admin view

Author: ethanandrews

api/config/admin.py

@@ -0,0 +1,20 @@
+from django.contrib import admin
+from django.template.response import TemplateResponse
+from django.urls import path
+
+from skills_matcher_db.core.views import AdminMetricsView
+
+
+class CustomAdminSite(admin.AdminSite):
+    index_template = "admin/custom_index.html"
+
+    def get_urls(
+        self,
+    ):
+        return [
+            path(
+                "metrics/",
+                AdminMetricsView.as_view(),
+                name="view_metrics",
+            ),
+        ] + super().get_urls()

api/config/urls.py

@@ -8,9 +8,16 @@
 
 from rest_framework.authtoken.views import obtain_auth_token
 
+from config.admin import CustomAdminSite
 from skills_matcher_db.users.api import jwt_views
 from skills_matcher_db.users.api.views import Ping
 
+# custom admin site class
+admin.site.__class__ = CustomAdminSite
+admin.site.site_header = "WHOI Skills Matcher Administration"
+admin.site.index_title = "Site administration"
+admin.site.site_title = "WHOI Skills Matcher Administration"
+
 urlpatterns = [
     path("", TemplateView.as_view(template_name="pages/home.html"), name="home"),
     path(

api/local.yml

@@ -16,7 +16,7 @@ services:
     volumes:
       - .:/app:z
     env_file:
-      - ./.envs/.local/.django
+      - ./.env
       - ./.envs/.local/.postgres
     ports:
       - "8000:8000"

api/skills_matcher_db/core/views.py

@@ -1,10 +1,47 @@
 from django.urls import reverse
-from django.views.generic.base import RedirectView
+from django.http import HttpResponseRedirect
+from django.views.generic.base import RedirectView, TemplateView
+from django.db.models.functions import TruncMonth
+from django.db.models import Count
+
+from skills_matcher_db.users.models import User
+from skills_matcher_db.project_owners.models import Project
 
 
 class AdminLoginView(RedirectView):
     def get(self, request, *args, **kwargs):
         """
-        Assuming the name of the external system's login url is "login"
+        Assuming the name of the external system's login url is "login
         """
         return HttpResponseRedirect(reverse("login"))
+
+
+class AdminMetricsView(TemplateView):
+    template_name = "admin/core/metrics.html"
+
+    def get_context_data(self, **kwargs):
+        context = super(AdminMetricsView, self).get_context_data(**kwargs)
+        # get user metric data
+        user_metrics_qs = (
+            User.objects.annotate(month=TruncMonth("date_joined"))
+            .values("month")
+            .annotate(user_count=Count("id"))
+            .order_by("month")
+        )
+
+        # get user metric data
+        projects_metrics_qs = (
+            Project.objects.annotate(month=TruncMonth("date_created"))
+            .values("month")
+            .annotate(project_count=Count("id"))
+            .order_by("month")
+        )
+
+        context.update(
+            {
+                "node_type": "assemblies",
+                "user_metrics": user_metrics_qs,
+                "project_metrics": projects_metrics_qs,
+            }
+        )
+        return context

api/skills_matcher_db/templates/admin/base_site.html

@@ -0,0 +1,13 @@
+{% extends "admin/base.html" %}
+
+{% load static %}
+
+{% block title %}{{ title }} | {{ site_title|default:_('Django site admin') }}{% endblock %}
+
+{% block extrastyle %}{{ block.super }}<link rel="stylesheet" type="text/css" href="{% static "css/admin-extra.css" %}" />{% endblock %}
+
+{% block branding %}
+<h1 id="site-name"><a href="{% url 'admin:index' %}">{{ site_header|default:_('Django administration') }}</a></h1>
+{% endblock %}
+
+{% block nav-global %}{% endblock %}

api/skills_matcher_db/templates/admin/core/metrics.html

@@ -0,0 +1,45 @@
+{# templates/admin/custom_page.html #}
+
+{% extends 'admin/change_list.html' %}
+{% load crispy_forms_tags %}
+
+{% block pagination %}
+{% endblock %}
+{% block filters %}{% endblock filters %}
+{% block object-tools %}{% endblock object-tools %}
+{% block search %}{% endblock %}
+
+{% block breadcrumbs %}
+<div class="breadcrumbs">
+    <a href="{% url 'admin:index' %}">Home</a>
+    {% if page_name %} &rsaquo; {{ page_name }}{% endif %}
+</div>
+{% endblock %}
+
+{% block result_list %}
+<div class="content">
+    <h1>Application Metrics</h1>
+
+    <h2>New Users by Month</h2>
+        <ul>
+            {% for item in user_metrics %}
+                <li>{{ item.month|date:"Y-m" }} - {{ item.user_count }} user</li>
+            {% empty %}
+                <li>No items found.</li>
+            {% endfor %}
+        </ul>
+        
+    
+    <h2>New Projects by Month</h2>
+    <ul>
+        {% for item in projects_metrics_qs %}
+            <li>{{ item.month|date:"Y-m" }} - {{ item.project_count }} project</li>
+        {% empty %}
+            <li>No items found.</li>
+        {% endfor %}
+    </ul>
+    
+
+
+</div>
+{% endblock result_list %}

api/skills_matcher_db/templates/admin/custom_app_list.html

@@ -0,0 +1,15 @@
+<div id="extra_links_wrapper" class="module">
+  <table>
+    <caption>
+      <a class="section" title="Metrics">Metrics</a>
+    </caption>
+    <tr>
+      <th scope="row">
+        <a href="{% url 'admin:view_metrics' %}"> View Metrics </a>
+      </th>
+      <td></td>
+    </tr>
+  </table>
+</div>
+
+{% include 'admin/app_list.html' %}

api/skills_matcher_db/templates/admin/custom_index.html

@@ -0,0 +1,7 @@
+{% extends "admin/index.html" %}
+
+{% block content %}
+<div id="content-main">
+  {% include "admin/custom_app_list.html" with app_list=app_list show_changelinks=True %}
+</div>
+{% endblock %}

api/skills_matcher_db/templates/admin/custom_page.html

@@ -0,0 +1,19 @@
+{# templates/admin/custom_page.html #}
+
+{% extends 'admin/change_list.html' %}
+
+{% block pagination %}{% endblock %}
+{% block filters %}{% endblock filters %}
+{% block object-tools %}{% endblock object-tools %}
+{% block search %}{% endblock %}
+
+{% block breadcrumbs %}
+<div class="breadcrumbs">
+  <a href="{% url 'admin:index' %}">Home</a>
+  {% if page_name %} &rsaquo; {{ page_name }}{% endif %}
+</div>
+{% endblock %}
+
+{% block result_list %}
+{{text}}
+{% endblock result_list %}