Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,064 changes: 987 additions & 77 deletions _docs/api/admin-openapi.json

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions core/cache_policy.py
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,7 @@
"management_api.event_views.event_reminders": PRIVATE_DYNAMIC,
"management_api.peer_review_views.course_peer_review_assignments": PRIVATE_DYNAMIC,
"management_api.peer_review_views.course_peer_reviews": PRIVATE_DYNAMIC,
"management_api.urls.course_certificate_template": PRIVATE_DYNAMIC,
"management_api.urls.credential_collection": PRIVATE_DYNAMIC,
"management_api.urls.event_item": PRIVATE_DYNAMIC,
"management_api.urls.event_qna_collection": PRIVATE_DYNAMIC,
Expand Down Expand Up @@ -394,6 +395,14 @@
"studio.event_views.event_update": PRIVATE_DYNAMIC,
"studio.event_views.speaker_create": PRIVATE_DYNAMIC,
"studio.event_views.speaker_list": PRIVATE_DYNAMIC,
"studio.certificate_views.course_certificate_template": PRIVATE_DYNAMIC,
"studio.certificate_views.course_certificate_template_write": PRIVATE_DYNAMIC,
"management_api.urls.certificate_list": PRIVATE_DYNAMIC,
"management_api.urls.cohort_certificate_preview": PRIVATE_DYNAMIC,
"management_api.urls.cohort_certificate_issue": PRIVATE_DYNAMIC,
"studio.certificate_views.certificates_page": PRIVATE_DYNAMIC,
"studio.certificate_views.cohort_certificate_preview": PRIVATE_DYNAMIC,
"studio.certificate_views.cohort_certificate_issue": PRIVATE_DYNAMIC,
"studio.peer_review_views.course_peer_review_assignments": PRIVATE_DYNAMIC,
"studio.peer_review_views.course_peer_reviews": PRIVATE_DYNAMIC,
"studio.views.audit_detail": PRIVATE_DYNAMIC,
Expand Down
5 changes: 3 additions & 2 deletions core/tests/test_deployment_workflow.py
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@
# test, and issue #515 enrolls scripts.convert_academy_source, in strict mypy
# (configuration only, no dependency change); the pyproject seal moves with
# that reviewed pyproject.
STUDIO_COURSES_PYPROJECT_SHA256 = "7a6a888f83f182bf4bdfa23f7e5b1002bc77691454d45e0cdc55416048f3bf8d"
STUDIO_COURSES_PYPROJECT_SHA256 = "c72e1d4598d441bdb2b48e5cd36f47523be35884bfbe35d020fd5418ee5179dd"
# Issue #456's cb v0.5.28 pin bump moved the lock one advisory step
# (urllib3 2.7.0 -> 2.8.0). Issue #462's v0.5.29 pin bump changes only the
# community-base entry (tag and commit 22d5fcd0); the reviewed remediation
Expand All @@ -200,8 +200,9 @@
# Community-base v0.5.35 adopts the immutable template version selection
# (2ec90c67); the reviewed lock seal tracks the entry and pin reference bytes.
# Intake 623a5c59 drops python-json-logger and tqdm from the lock.
# Certificates intake aa1a414f adds segno (QR codes) to pyproject and the lock.
SECURITY_REMEDIATED_UV_LOCK_SHA256 = (
"cae9bc7383f040ec3c603160b5254401b505dd4e9c1cd1e97459ba8cdbe73c98"
"3868e17e872d3c62a631702f763e54c96ae74354ebfe2e68beffa621588743d3"
)
SECRET_PREFIX = (
f"arn:aws:secretsmanager:{SELECTED_TARGET.aws_region}:{SELECTED_TARGET.aws_account_id}"
Expand Down
2 changes: 1 addition & 1 deletion courses/admin/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
from . import course, homework, projects, testimonial, wrapped # noqa: F401
from . import certificate, course, homework, projects, testimonial, wrapped # noqa: F401
12 changes: 12 additions & 0 deletions courses/admin/certificate.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
from django.contrib import admin
from unfold.admin import ModelAdmin # type: ignore[import-untyped]

from courses.models.certificate import CertificateTemplate


@admin.register(CertificateTemplate)
class CertificateTemplateAdmin(ModelAdmin):
"""Per-course certificate rendering and publishing settings."""

list_display = ("course", "banner_template", "banner_size", "s3_bucket")
search_fields = ("course__slug", "course__title")
88 changes: 88 additions & 0 deletions courses/certificate_capabilities.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
"""Management capabilities for per-course certificate templates."""

from __future__ import annotations

from core.capabilities import (
AdapterMetadata,
Capability,
ConcurrencyPolicy,
IdempotencyPolicy,
ServiceKind,
)
from courses.services.certificate_template_admin import (
WRITABLE_FIELDS,
read_certificate_template,
write_certificate_template,
)

_EMPTY_RESULT = {
"course": "",
"course_title": "",
"banner_template": "",
"banner_size": "",
"url_base": "",
"s3_bucket": "",
"cloudfront_distribution_id": "",
"date_timezone": "",
"cohort": None,
"last_project_deadline": None,
}

CERTIFICATE_TEMPLATE_READ = Capability(
key="courses.certificate_template.read",
description="Read a course's certificate template and its last project deadline",
service_kind=ServiceKind.QUERY,
service=read_certificate_template,
django_permission="courses.view_certificatetemplate",
studio=AdapterMetadata(
route="studio:course-certificate-template",
method="GET",
operation_id="courses.certificate_template.read.html",
),
admin_api=AdapterMetadata(
route="/api/v1/admin/courses/{slug}/certificate-template",
method="GET",
operation_id="admin.courses.certificate_template.read",
scopes=("courses.certificate_template.read",),
result_schema="CourseCertificateTemplateResponse",
rate_class="read",
rate_cost=1,
),
idempotency=IdempotencyPolicy.NONE,
concurrency=ConcurrencyPolicy.NONE,
audit_action="courses.certificate_template.read",
redacted_fields=("authorization", "cookie"),
test_factory=lambda: dict(_EMPTY_RESULT),
)

CERTIFICATE_TEMPLATE_WRITE = Capability(
key="courses.certificate_template.write",
description="Create or update a course's certificate template",
service_kind=ServiceKind.COMMAND,
service=write_certificate_template,
django_permission="courses.change_certificatetemplate",
studio=AdapterMetadata(
route="studio:course-certificate-template-write",
method="POST",
operation_id="courses.certificate_template.write.html",
writable_fields=WRITABLE_FIELDS,
),
admin_api=AdapterMetadata(
route="/api/v1/admin/courses/{slug}/certificate-template",
method="PUT",
operation_id="admin.courses.certificate_template.write",
scopes=("courses.certificate_template.write",),
request_schema="CourseCertificateTemplateRequest",
result_schema="CourseCertificateTemplateResponse",
writable_fields=WRITABLE_FIELDS,
rate_class="write",
rate_cost=2,
),
idempotency=IdempotencyPolicy.OPTIONAL,
concurrency=ConcurrencyPolicy.NONE,
audit_action="courses.certificate_template.written",
redacted_fields=("authorization", "cookie"),
test_factory=lambda: dict(_EMPTY_RESULT),
)

CERTIFICATE_TEMPLATE_CAPABILITIES = (CERTIFICATE_TEMPLATE_READ, CERTIFICATE_TEMPLATE_WRITE)
115 changes: 115 additions & 0 deletions courses/certificate_generation_capabilities.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
"""Management capabilities that render and issue certificates for a cohort."""

from __future__ import annotations

from core.capabilities import (
AdapterMetadata,
Capability,
ConcurrencyPolicy,
IdempotencyPolicy,
ServiceKind,
)
from courses.services.certificates import issue_service, list_service, preview_service

_PREVIEW_EMPTY = {
"cohort": "",
"name": "",
"format": "pdf",
"date": "",
"content_type": "application/pdf",
"filename": "",
"content_base64": "",
}
_ISSUE_EMPTY = {
"cohort": "",
"date": "",
"graduate_count": 0,
"graduates": [],
"executed": False,
"issued": [],
}

CERTIFICATE_PREVIEW = Capability(
key="courses.certificate.preview",
description="Render one throwaway certificate for a cohort (nothing is published)",
service_kind=ServiceKind.COMMAND,
service=preview_service,
django_permission="courses.view_certificatetemplate",
studio=AdapterMetadata(
route="studio:cohort-certificate-preview",
method="POST",
operation_id="courses.certificate.preview.html",
),
admin_api=AdapterMetadata(
route="/api/v1/admin/cohorts/{slug}/certificates/preview",
method="POST",
operation_id="admin.cohorts.certificate.preview",
scopes=("courses.certificate.preview",),
request_schema="CohortCertificatePreviewRequest",
result_schema="CohortCertificatePreviewResponse",
rate_class="write",
rate_cost=5,
),
idempotency=IdempotencyPolicy.OPTIONAL,
concurrency=ConcurrencyPolicy.NONE,
audit_action="courses.certificate.previewed",
redacted_fields=("authorization", "cookie"),
test_factory=lambda: dict(_PREVIEW_EMPTY),
)

CERTIFICATE_ISSUE = Capability(
key="courses.certificate.issue",
description="Plan or issue (render, publish, record URL) certificates for graduates",
service_kind=ServiceKind.COMMAND,
service=issue_service,
django_permission="courses.change_certificatetemplate",
studio=AdapterMetadata(
route="studio:cohort-certificate-issue",
method="POST",
operation_id="courses.certificate.issue.html",
),
admin_api=AdapterMetadata(
route="/api/v1/admin/cohorts/{slug}/certificates/issue",
method="POST",
operation_id="admin.cohorts.certificate.issue",
scopes=("courses.certificate.issue",),
request_schema="CohortCertificateIssueRequest",
result_schema="CohortCertificateIssueResponse",
rate_class="write",
rate_cost=10,
),
idempotency=IdempotencyPolicy.OPTIONAL,
concurrency=ConcurrencyPolicy.NONE,
audit_action="courses.certificate.issued",
redacted_fields=("authorization", "cookie"),
test_factory=lambda: dict(_ISSUE_EMPTY),
)

CERTIFICATE_LIST = Capability(
key="courses.certificate.list",
description="Certificates",
service_kind=ServiceKind.QUERY,
service=list_service,
django_permission="courses.view_certificatetemplate",
studio=AdapterMetadata(
route="studio:certificates",
method="GET",
operation_id="courses.certificate.list.html",
),
admin_api=AdapterMetadata(
route="/api/v1/admin/certificates",
method="GET",
operation_id="admin.certificates.list",
scopes=("courses.certificate.list",),
result_schema="CertificateCohortListResponse",
rate_class="read",
rate_cost=2,
),
idempotency=IdempotencyPolicy.NONE,
concurrency=ConcurrencyPolicy.NONE,
audit_action="courses.certificate.listed",
redacted_fields=("authorization", "cookie"),
test_factory=lambda: {"items": []},
)

CERTIFICATE_GENERATION_CAPABILITIES = (CERTIFICATE_LIST, CERTIFICATE_PREVIEW, CERTIFICATE_ISSUE)
27 changes: 27 additions & 0 deletions courses/migrations/0037_certificate_template.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Generated by Django 6.0.8 on 2026-11-20 21:00

import django.db.models.deletion
from django.db import migrations, models


class Migration(migrations.Migration):

dependencies = [
('courses', '0036_project_criteria_set'),
]

operations = [
migrations.CreateModel(
name='CertificateTemplate',
fields=[
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
('banner_template', models.SlugField(default='dtc-zoomcamp-certificate', help_text='Banner Generator template name, for example dtc-zoomcamp-certificate.', max_length=100)),
('banner_size', models.SlugField(default='zoomcamp-certificate', help_text='Banner Generator size key (zoomcamp-certificate is 1920x1080).')),
('url_base', models.URLField(default='https://certificate.datatalks.club', help_text='Public origin the issued PDFs are served from.')),
('s3_bucket', models.CharField(default='certificate.datatalks.club', max_length=255)),
('cloudfront_distribution_id', models.CharField(blank=True, max_length=64)),
('date_timezone', models.CharField(default='Europe/Berlin', help_text='Timezone the last project deadline is converted to for the printed date.', max_length=64)),
('course', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, related_name='certificate_template', to='courses.course')),
],
),
]
2 changes: 2 additions & 0 deletions courses/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
testimonial,
wrapped,
)
from .certificate import CertificateTemplate
from .cmp_import import (
CmpHistoryClaim,
CmpHistoryImportBinding,
Expand Down Expand Up @@ -91,6 +92,7 @@
__all__ = (
"Answer",
"AnswerTypes",
"CertificateTemplate",
"CmpHistoryClaim",
"CmpHistoryImportBinding",
"CmpHistoryImportProgress",
Expand Down
58 changes: 58 additions & 0 deletions courses/models/certificate.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
"""Per-course certificate template configuration.

One row per course family says how that course's certificates are rendered and
published. The rendering engine is the Banner Generator
(``AI-Shipping-Labs/banner-generator``); ``banner_template`` names one of its
bundled certificate templates. Everything that differs between two cohorts of
the same course (title, year, date) is derived from the cohort and its project
deadlines, never typed here.
"""

from __future__ import annotations

from zoneinfo import available_timezones

from django.core.exceptions import ValidationError
from django.db import models

from courses.models.cohort import Course

DEFAULT_CERTIFICATE_URL_BASE = "https://certificate.datatalks.club"
DEFAULT_CERTIFICATE_BUCKET = "certificate.datatalks.club"


class CertificateTemplate(models.Model):
course = models.OneToOneField(
Course, on_delete=models.CASCADE, related_name="certificate_template"
)
banner_template = models.SlugField(
max_length=100,
default="dtc-zoomcamp-certificate",
help_text="Banner Generator template name, for example dtc-zoomcamp-certificate.",
)
banner_size = models.SlugField(
max_length=50,
default="zoomcamp-certificate",
help_text="Banner Generator size key (zoomcamp-certificate is 1920x1080).",
)
url_base = models.URLField(
default=DEFAULT_CERTIFICATE_URL_BASE,
help_text="Public origin the issued PDFs are served from.",
)
s3_bucket = models.CharField(max_length=255, default=DEFAULT_CERTIFICATE_BUCKET)
cloudfront_distribution_id = models.CharField(max_length=64, blank=True)
date_timezone = models.CharField(
max_length=64,
default="Europe/Berlin",
help_text="Timezone the last project deadline is converted to for the printed date.",
)

def __str__(self):
return f"Certificate template for {self.course}"

def clean(self):
super().clean()
if self.date_timezone not in available_timezones():
raise ValidationError({"date_timezone": "Unknown timezone."})
if self.url_base.endswith("/"):
raise ValidationError({"url_base": "Use an origin without a trailing slash."})
Loading
Loading