Add django command that export course certificates

nau_openedx_extensions/management/commands/export_course_certificates.py

@@ -0,0 +1,105 @@
+"""
+Export all PDF course certificates with its links to a csv file and upload it to the
+`GRADES_DOWNLOAD` storage.
+
+To manually develop the script you can edit it on the fly and execute it.
+docker cp export_course_certificates.py \
+    openedx_lms:/openedx/venv/lib/python3.8/site-packages/nau_openedx_extensions/management/commands/export_course_certificates.py && \
+    docker exec -i openedx_lms python manage.py lms export_course_certificates course-v1:FCT+CTC101x+2020_T2
+"""
+
+import logging
+from datetime import datetime
+
+from django.conf import settings
+from django.core.management.base import BaseCommand
+from lms.djangoapps.certificates.models import GeneratedCertificate
+from lms.djangoapps.instructor_task.tasks_helper.utils import (  # lint-amnesty, pylint: disable=unused-import
+    upload_csv_to_report_store,
+)
+from opaque_keys.edx.keys import CourseKey
+from openedx.core.djangoapps.site_configuration.models import SiteConfiguration
+
+from pytz import UTC
+
+log = logging.getLogger(__name__)
+
+
+class Command(BaseCommand):
+    """
+    Export all PDF course certificates with its links to a csv file and upload it to the
+    `GRADES_DOWNLOAD` storage.
+    """
+
+    def add_arguments(self, parser):
+        parser.add_argument("course_ids", nargs="*", metavar="course_id")
+        parser.add_argument("--all", action="store_true", help="Reindex all courses")
+
+    def handle(self, *args, **options):
+        """
+        Execute the command
+        """
+        course_ids = options["course_ids"]
+
+        for course_id in course_ids:
+            course_key = CourseKey.from_string(course_id)
+
+            start_date = datetime.now(UTC)
+            rows = self._certificates(course_id)
+            upload_csv_to_report_store(
+                rows,
+                "export_course_certificates",
+                course_key,
+                start_date,
+            )
+
+    def _certificates(self, course_id):
+        """
+        Iterate the course certificates and return each line.
+        """
+        course_generated_certificates = GeneratedCertificate.objects.filter(
+            course_id=course_id
+        )
+
+        course_key = CourseKey.from_string(course_id)
+        lms_base = SiteConfiguration.get_value_for_org(
+            course_key.org, "LMS_BASE", settings.LMS_BASE
+        )
+
+        # prepare output
+        rows = []
+
+        # append header
+        rows.append(
+            [
+                "course_id",
+                "student email",
+                "student name",
+                "certificate verify_uuid",
+                "certificate_web_link_url",
+                "certificate_download_pdf_link",
+            ]
+        )
+
+        # iterate each certificate and append each certificate as a row
+        for certificate in course_generated_certificates:
+            certificate_web_link_url = (
+                "https://" + lms_base + "/certificates/" + certificate.verify_uuid
+            )
+            certificate_download_pdf_link = (
+                "https://course-certificate.nau.edu.pt/attachment/certificates/"
+                + certificate.verify_uuid
+            )
+
+            rows.append(
+                [
+                    course_id,
+                    certificate.user.email,
+                    certificate.name,
+                    certificate.verify_uuid,
+                    certificate_web_link_url,
+                    certificate_download_pdf_link,
+                ]
+            )
+
+        return rows