feat: add django admin page for survey report

openedx/features/survey_report/admin.py

@@ -0,0 +1,89 @@
+"""
+Django Admin page for SurveyReport.
+"""
+
+
+from django.contrib import admin
+from django import forms
+from .models import SurveyReport
+
+
+class SurveyReportForm(forms.ModelForm):
+    """
+    ModelForm to survey report.
+    """
+    class Meta:
+        model = SurveyReport
+        help_texts = {
+            'courses_offered': 'Total number of active unique courses.',
+            'learners': 'Total number of recently active users with login in some weeks.',
+            'registered_learners': 'Total number of users ever registered in the platform.',
+            'enrollments': 'Total number of active enrollments in the platform.',
+            'generated_certificates': 'Total number of generated certificates.',
+            'extra_data': 'Extra information that will be saved in the report, E.g: site_name, openedx-release.',
+        }
+        fields = '__all__'
+
+
+class SurveyReportAdmin(admin.ModelAdmin):
+    """
+    Admin to manage survey reports.
+    """
+    form = SurveyReportForm
+
+    readonly_fields = (
+        'courses_offered', 'learners', 'registered_learners',
+        'enrollments', 'generated_certificates', 'extra_data',
+        'created_at'
+    )
+
+    list_display = (
+        'id', 'summary', 'created_at'
+    )
+
+    def summary(self, obj) -> str:
+        """
+        Show a summary of the survey report.
+        info:
+        - Courses: Total number of active unique courses.
+        - Learners: Recently active users with login in some weeks.
+        - Enrollments: Total number of active enrollments in the platform.
+        """
+        return f"Total Courses: {obj.courses_offered}," \
+               f"Total Learners: {obj.learners}, Total Enrollments: {obj.enrollments}"
+
+    def has_add_permission(self, request):
+        """
+        Removes the "add" button from admin.
+        """
+        return False
+
+    def has_delete_permission(self, request, obj=None):
+        """
+        Removes the "delete" options from admin.
+        """
+        return False
+
+    def changeform_view(self, request, object_id=None, form_url='', extra_context=None):
+        """
+        Removes the "save" buttons from admin change view.
+        """
+        extra_context = extra_context or {}
+
+        extra_context['show_save'] = False
+        extra_context['show_save_and_continue'] = False
+        extra_context['show_save_and_add_another'] = False
+
+        return super().changeform_view(request, object_id, form_url, extra_context)
+
+    def get_actions(self, request):
+        """
+        Removes the default bulk delete option provided by Django,
+        it doesn't do what we need for this model.
+        """
+        actions = super().get_actions(request)
+        if 'delete_selected' in actions:
+            del actions['delete_selected']
+        return actions
+
+admin.site.register(SurveyReport, SurveyReportAdmin)