feat: run command from admin

Author: asadali145

src/ol_openedx_uai_content_customization/README.rst

@@ -137,6 +137,39 @@ Options
     Print what would be created without writing anything to the modulestore.
     Use this to verify CSV mapping before committing.
 
+Run from Django Admin
+~~~~~~~~~~~~~~~~~~~~~
+
+You can run the same workflow from CMS Django admin using an async job model:
+
+1. Open **Django Admin** and navigate to **UAI Course Generation Jobs**.
+2. Create a new job and upload:
+
+    - ``customized_csv``
+    - ``video_assets_csv``
+
+3. Optionally set:
+
+    - ``username`` (defaults to ``studio_worker``)
+    - ``dry_run``
+
+4. Save the job, select it in the changelist, then run action
+   **Run selected UAI generation job(s)**.
+5. Track progress via ``status`` and inspect command logs in ``output``.
+
+Status values:
+
+* ``pending`` - job queued to run.
+* ``running`` - task is currently executing.
+* ``succeeded`` - command completed successfully.
+* ``failed`` - command failed; check ``output`` for details.
+
+.. note::
+
+   Admin execution is asynchronous and requires a running Celery worker.
+   Use ``dry_run`` first for large CSV uploads to validate mappings before
+   creating courses.
+
 How It Works
 ~~~~~~~~~~~~
 

src/ol_openedx_uai_content_customization/ol_openedx_uai_content_customization/admin.py

@@ -0,0 +1,84 @@
+"""Django admin for UAI course generation jobs."""
+
+from django.contrib import admin, messages
+
+from ol_openedx_uai_content_customization.models import UAICourseGenerationJob
+from ol_openedx_uai_content_customization.tasks import run_uai_course_generation_job
+
+
+@admin.register(UAICourseGenerationJob)
+class UAICourseGenerationJobAdmin(admin.ModelAdmin):
+    """Admin UI for creating and running UAI generation jobs."""
+
+    list_display = (
+        "id",
+        "status",
+        "dry_run",
+        "username",
+        "created_by",
+        "created_at",
+        "started_at",
+        "completed_at",
+    )
+    list_filter = ("status", "dry_run", "created_at")
+    search_fields = ("username", "created_by__username", "task_id")
+    readonly_fields = (
+        "status",
+        "output",
+        "task_id",
+        "created_by",
+        "started_at",
+        "completed_at",
+        "created_at",
+        "updated_at",
+    )
+    actions = ("run_selected_jobs",)
+
+    @admin.action(description="Run selected UAI generation job(s)")
+    def run_selected_jobs(self, request, queryset):
+        """Queue selected jobs for asynchronous execution."""
+        queued = 0
+        skipped = 0
+
+        for job in queryset:
+            if job.status == UAICourseGenerationJob.Status.RUNNING:
+                skipped += 1
+                continue
+
+            job.status = UAICourseGenerationJob.Status.PENDING
+            job.started_at = None
+            job.completed_at = None
+            job.output = ""
+            task = run_uai_course_generation_job.delay(job.id)
+            job.task_id = task.id or ""
+            job.save(
+                update_fields=[
+                    "status",
+                    "started_at",
+                    "completed_at",
+                    "output",
+                    "task_id",
+                    "updated_at",
+                ]
+            )
+            queued += 1
+
+        if queued:
+            self.message_user(
+                request,
+                f"Queued {queued} UAI generation job(s).",
+                level=messages.SUCCESS,
+            )
+
+        if skipped:
+            self.message_user(
+                request,
+                f"Skipped {skipped} running job(s).",
+                level=messages.WARNING,
+            )
+
+    def save_model(self, request, obj, form, change):
+        """Stamp job creator for new records."""
+        if not change and not obj.created_by:
+            obj.created_by = request.user
+        super().save_model(request, obj, form, change)

src/ol_openedx_uai_content_customization/ol_openedx_uai_content_customization/migrations/0001_initial.py

@@ -0,0 +1,107 @@
+# Generated by Django 5.2.14 on 2026-05-19 09:32
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="UAICourseGenerationJob",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "customized_csv",
+                    models.FileField(
+                        help_text="Customized video metadata CSV.",
+                        upload_to="ol_openedx_uai_content_customization/jobs/",
+                    ),
+                ),
+                (
+                    "video_assets_csv",
+                    models.FileField(
+                        help_text="Open edX video asset CSV.",
+                        upload_to="ol_openedx_uai_content_customization/jobs/",
+                    ),
+                ),
+                (
+                    "username",
+                    models.CharField(
+                        default="studio_worker",
+                        help_text="Platform username used to create/publish courses.",
+                        max_length=150,
+                    ),
+                ),
+                (
+                    "dry_run",
+                    models.BooleanField(
+                        default=False,
+                        help_text=(
+                            "When enabled, validate and report actions "
+                            "without writing data."
+                        ),
+                    ),
+                ),
+                (
+                    "status",
+                    models.CharField(
+                        choices=[
+                            ("pending", "Pending"),
+                            ("running", "Running"),
+                            ("succeeded", "Succeeded"),
+                            ("failed", "Failed"),
+                        ],
+                        db_index=True,
+                        default="pending",
+                        max_length=16,
+                    ),
+                ),
+                (
+                    "output",
+                    models.TextField(
+                        blank=True, help_text="Captured command output and failures."
+                    ),
+                ),
+                (
+                    "task_id",
+                    models.CharField(
+                        blank=True,
+                        help_text="Celery task ID for tracking asynchronous execution.",
+                        max_length=255,
+                    ),
+                ),
+                ("started_at", models.DateTimeField(blank=True, null=True)),
+                ("completed_at", models.DateTimeField(blank=True, null=True)),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                (
+                    "created_by",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="uai_course_generation_jobs",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ("-created_at",),
+            },
+        ),
+    ]

src/ol_openedx_uai_content_customization/ol_openedx_uai_content_customization/migrations/__init__.py

@@ -0,0 +1,96 @@
+"""Models for ol-openedx-uai-content-customization plugin."""
+
+from django.conf import settings
+from django.core.exceptions import ValidationError
+from django.db import models
+
+
+class UAICourseGenerationJob(models.Model):
+    """Admin-managed job to run ``generate_uai_courses`` asynchronously."""
+
+    objects = models.Manager()
+
+    class Status(models.TextChoices):
+        """Allowed execution states for a generation job."""
+
+        PENDING = "pending", "Pending"
+        RUNNING = "running", "Running"
+        SUCCEEDED = "succeeded", "Succeeded"
+        FAILED = "failed", "Failed"
+
+    customized_csv = models.FileField(
+        upload_to="ol_openedx_uai_content_customization/jobs/",
+        help_text="Customized video metadata CSV.",
+    )
+    video_assets_csv = models.FileField(
+        upload_to="ol_openedx_uai_content_customization/jobs/",
+        help_text="Open edX video asset CSV.",
+    )
+    username = models.CharField(
+        max_length=150,
+        default="studio_worker",
+        help_text="Platform username used to create/publish courses.",
+    )
+    dry_run = models.BooleanField(
+        default=False,
+        help_text="When enabled, validate and report actions without writing data.",
+    )
+    status = models.CharField(
+        max_length=16,
+        choices=Status.choices,
+        default=Status.PENDING,
+        db_index=True,
+    )
+    output = models.TextField(
+        blank=True,
+        help_text="Captured command output and failures.",
+    )
+    task_id = models.CharField(
+        max_length=255,
+        blank=True,
+        help_text="Celery task ID for tracking asynchronous execution.",
+    )
+    created_by = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        null=True,
+        blank=True,
+        on_delete=models.SET_NULL,
+        related_name="uai_course_generation_jobs",
+    )
+    started_at = models.DateTimeField(null=True, blank=True)
+    completed_at = models.DateTimeField(null=True, blank=True)
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    class Meta:
+        """Meta options for UAICourseGenerationJob."""
+
+        app_label = "ol_openedx_uai_content_customization"
+        ordering = ("-created_at",)
+
+    def __str__(self):
+        """Return concise job identification for admin listings."""
+        return f"UAI Generation Job #{self.pk} ({self.status})"
+
+    def save(self, *args, **kwargs):
+        """Persist only validated job records."""
+        self.full_clean()
+        super().save(*args, **kwargs)
+
+    def clean(self):
+        """Validate uploaded files are CSVs."""
+        super().clean()
+        errors = {}
+
+        if self.customized_csv and not self.customized_csv.name.lower().endswith(
+            ".csv"
+        ):
+            errors["customized_csv"] = "File must have a .csv extension."
+
+        if self.video_assets_csv and not self.video_assets_csv.name.lower().endswith(
+            ".csv"
+        ):
+            errors["video_assets_csv"] = "File must have a .csv extension."
+
+        if errors:
+            raise ValidationError(errors)