learning-paths-plugin 0.3.4rc6__tar.gz → 0.3.4rc9__tar.gz

{learning_paths_plugin-0.3.4rc6 → learning_paths_plugin-0.3.4rc9}/CHANGELOG.rst

@@ -24,11 +24,16 @@ Added
 
 * Bulk unenrollment API.
 * Enrollment audit model that tracks the enrollment state transitions.
+* Allow specifying time commitment.
+* Allow duplicating Learning Paths in the Django admin interface.
 
 Changed
 =======
 
 * The Learning Paths API includes start and end dates for its steps.
+* Return enrollment date in the API instead of a boolean.
+* Allow specifying any text for the duration.
+* Make the skill level optional.
 
 0.3.3 - 2025-05-23
 ******************

{learning_paths_plugin-0.3.4rc6/learning_paths_plugin.egg-info → learning_paths_plugin-0.3.4rc9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-paths-plugin
-Version: 0.3.4rc6
+Version: 0.3.4rc9
 Summary: Learning Paths plugin
 Home-page: https://github.com/open-craft/learning-paths-plugin
 Author: OpenCraft
@@ -18,6 +18,7 @@ Requires-Python: >=3.11
 License-File: LICENSE.txt
 Requires-Dist: Django
 Requires-Dist: django-model-utils
+Requires-Dist: django-object-actions
 Requires-Dist: djangorestframework
 Requires-Dist: edx-django-utils
 Requires-Dist: edx-opaque-keys
@@ -128,11 +129,16 @@ Added
 
 * Bulk unenrollment API.
 * Enrollment audit model that tracks the enrollment state transitions.
+* Allow specifying time commitment.
+* Allow duplicating Learning Paths in the Django admin interface.
 
 Changed
 =======
 
 * The Learning Paths API includes start and end dates for its steps.
+* Return enrollment date in the API instead of a boolean.
+* Allow specifying any text for the duration.
+* Make the skill level optional.
 
 0.3.3 - 2025-05-23
 ******************

{learning_paths_plugin-0.3.4rc6 → learning_paths_plugin-0.3.4rc9}/learning_paths/__init__.py

@@ -2,4 +2,4 @@
 Learning Paths plugin.
 """
 
-__version__ = "0.3.4-rc6"
+__version__ = "0.3.4-rc9"

{learning_paths_plugin-0.3.4rc6 → learning_paths_plugin-0.3.4rc9}/learning_paths/admin.py

@@ -2,11 +2,17 @@
 Django Admin for learning_paths.
 """
 
+import os
+
 from django import forms
-from django.contrib import admin, auth
+from django.contrib import admin, auth, messages
 from django.core.exceptions import ValidationError
+from django.core.files.base import ContentFile
 from django.db import transaction
+from django.http import HttpResponseRedirect
+from django.urls import reverse
 from django.utils.translation import gettext_lazy as _
+from django_object_actions import DjangoObjectActions, action
 
 from .compat import get_course_keys_with_outlines
 from .models import (
@@ -105,6 +111,7 @@ class LearningPathGradingCriteriaInline(admin.TabularInline):
     """Inline Admin for Learning path grading criteria."""
 
     model = LearningPathGradingCriteria
+    verbose_name = "Certificate Criteria"
 
 
 class BulkEnrollUsersForm(forms.ModelForm):
@@ -138,7 +145,7 @@ class BulkEnrollUsersForm(forms.ModelForm):
 
 
 @admin.register(LearningPath)
-class LearningPathAdmin(admin.ModelAdmin):
+class LearningPathAdmin(DjangoObjectActions, admin.ModelAdmin):
     """Admin for Learning Path."""
 
     model = LearningPath
@@ -152,7 +159,7 @@ class LearningPathAdmin(admin.ModelAdmin):
         "key",
         "display_name",
         "level",
-        "duration_in_days",
+        "duration",
         "invite_only",
     )
     list_filter = ("invite_only",)
@@ -165,6 +172,8 @@ class LearningPathAdmin(admin.ModelAdmin):
         LearningPathGradingCriteriaInline,
     ]
 
+    change_actions = ("duplicate_learning_path",)
+
     def get_readonly_fields(self, request, obj=None):
         """Make key read-only only for existing objects."""
         if obj:  # Editing an existing object.
@@ -178,6 +187,72 @@ class LearningPathAdmin(admin.ModelAdmin):
             for user in form.cleaned_data["usernames"]:
                 LearningPathEnrollment.objects.get_or_create(user=user, learning_path=form.instance)
 
+    @action(label="Duplicate Learning Path", description="Create a copy of this Learning Path")
+    def duplicate_learning_path(self, request, obj: LearningPath) -> HttpResponseRedirect:
+        """Duplicate the learning path with a new unique key."""
+        base_new_key = f"{str(obj.key)}_copy"
+        new_key = base_new_key
+        counter = 1
+
+        while LearningPath.objects.filter(key=new_key).exists():
+            new_key = f"{base_new_key}_{counter}"
+            counter += 1
+
+        with transaction.atomic():
+            new_learning_path = LearningPath(
+                key=new_key,
+                display_name=f"{obj.display_name} (Copy)",
+                subtitle=obj.subtitle,
+                description=obj.description,
+                level=obj.level,
+                duration=obj.duration,
+                time_commitment=obj.time_commitment,
+                sequential=obj.sequential,
+                invite_only=obj.invite_only,
+            )
+
+            if obj.image:
+                with obj.image.open('rb') as original_file:
+                    image_content = original_file.read()
+
+                original_filename = os.path.basename(obj.image.name)
+                new_learning_path.image.save(
+                    original_filename,
+                    ContentFile(image_content),
+                    save=False
+                )
+
+            new_learning_path.save()
+
+            new_learning_path.refresh_from_db()
+            new_learning_path.grading_criteria.required_completion = obj.grading_criteria.required_completion
+            new_learning_path.grading_criteria.required_grade = obj.grading_criteria.required_grade
+            new_learning_path.grading_criteria.save()
+
+            for step in obj.steps.all():
+                step.pk = None
+                step.learning_path = new_learning_path
+                step.save()
+
+            for skill in obj.requiredskill_set.all():
+                skill.pk = None
+                skill.learning_path = new_learning_path
+                skill.save()
+
+            for skill in obj.acquiredskill_set.all():
+                skill.pk = None
+                skill.learning_path = new_learning_path
+                skill.save()
+
+        messages.success(
+            request,
+            f'Learning path duplicated successfully. New key: {new_key}'
+        )
+
+        return HttpResponseRedirect(
+            reverse('admin:learning_paths_learningpath_change', args=[new_learning_path.pk])
+        )
+
 
 @admin.register(Skill)
 class SkillAdmin(admin.ModelAdmin):
@@ -249,8 +324,8 @@ class EnrolledUsersAdmin(admin.ModelAdmin):
         "id",
         "user",
         "learning_path",
-        "enrolled_at",
         "is_active",
+        "created",
     ]
 
     list_filter = [

{learning_paths_plugin-0.3.4rc6 → learning_paths_plugin-0.3.4rc9}/learning_paths/api/v1/serializers.py

@@ -105,7 +105,7 @@ class LearningPathListSerializer(serializers.ModelSerializer):
 
     steps = LearningPathStepSerializer(many=True, read_only=True)
     required_completion = serializers.FloatField(source="grading_criteria.required_completion", read_only=True)
-    is_enrolled = serializers.SerializerMethodField()
+    enrollment_date = serializers.SerializerMethodField()
     invite_only = serializers.BooleanField()
     image = serializers.ImageField(read_only=True)
 
@@ -118,17 +118,17 @@ class LearningPathListSerializer(serializers.ModelSerializer):
             "sequential",
             "steps",
             "required_completion",
-            "is_enrolled",
+            "enrollment_date",
             "invite_only",
         ]
 
-    def get_is_enrolled(self, obj):
+    def get_enrollment_date(self, obj):
         """
         Check if the current user is enrolled in this learning path.
         """
-        if hasattr(obj, "is_enrolled"):
-            return obj.is_enrolled
-        return False
+        if hasattr(obj, "enrollment_date"):
+            return obj.enrollment_date
+        return None
 
 
 class SkillSerializer(serializers.ModelSerializer):
@@ -174,7 +174,8 @@ class LearningPathDetailSerializer(LearningPathListSerializer):
             "subtitle",
             "description",
             "level",
-            "duration_in_days",
+            "duration",
+            "time_commitment",
             "required_skills",
             "acquired_skills",
         ]
@@ -183,4 +184,4 @@ class LearningPathDetailSerializer(LearningPathListSerializer):
 class LearningPathEnrollmentSerializer(serializers.ModelSerializer):
     class Meta:
         model = LearningPathEnrollment
-        fields = ("user", "learning_path", "is_active", "enrolled_at")
+        fields = ("user", "learning_path", "is_active", "created")

{learning_paths_plugin-0.3.4rc6 → learning_paths_plugin-0.3.4rc9}/learning_paths/api/v1/views.py

@@ -3,7 +3,6 @@ Views for LearningPath.
 """
 
 import logging
-from datetime import datetime, timezone
 
 from django.conf import settings
 from django.contrib.auth import get_user_model
@@ -242,7 +241,6 @@ class LearningPathEnrollmentView(APIView):
             return Response({"detail": "Enrollment exists."}, status=status.HTTP_409_CONFLICT)
 
         enrollment.is_active = True
-        enrollment.enrolled_at = datetime.now(timezone.utc)
         enrollment.save()
         return Response(LearningPathEnrollmentSerializer(enrollment).data)
 
@@ -389,7 +387,6 @@ class BulkEnrollView(APIView):
                 if enrollment:
                     if not enrollment.is_active:
                         enrollment.is_active = True
-                        enrollment.enrolled_at = datetime.now(timezone.utc)
                         enrolled_now = True
                     else:
                         audit_data["state_transition"] = LearningPathEnrollmentAudit.ENROLLED_TO_ENROLLED
@@ -519,7 +516,7 @@ class LearningPathCourseEnrollmentView(APIView):
         :raises: Http404 if the learning path is not found or the user does not have access.
         """
         return get_object_or_404(
-            LearningPath.objects.get_paths_visible_to_user(self.request.user).filter(is_enrolled=True),
+            LearningPath.objects.get_paths_visible_to_user(self.request.user).filter(enrollment_date__isnull=False),
             key=learning_path_key_str,
         )
 

{learning_paths_plugin-0.3.4rc6 → learning_paths_plugin-0.3.4rc9}/learning_paths/migrations/0013_enrollment_audit.py

@@ -155,4 +155,15 @@ class Migration(migrations.Migration):
                 "abstract": False,
             },
         ),
+        migrations.AddField(
+            model_name="learningpathenrollmentallowed",
+            name="is_active",
+            field=models.BooleanField(
+                db_index=True, default=True, help_text="Indicates if the enrollment allowance is active"
+            ),
+        ),
+        migrations.RemoveField(
+            model_name="learningpathenrollment",
+            name="enrolled_at",
+        ),
     ]

learning_paths_plugin-0.3.4rc9/learning_paths/migrations/0014_remove_learningpath_duration_in_days_and_more.py

@@ -0,0 +1,59 @@
+# Generated by Django 4.2.20 on 2025-07-14 13:10
+
+from django.db import migrations, models
+
+
+def transfer_duration_data(apps, schema_editor):
+    """Transfer duration_in_days values to duration field with '{x} days' format."""
+    LearningPath = apps.get_model("learning_paths", "LearningPath")
+
+    for learning_path in LearningPath.objects.filter(duration_in_days__isnull=False):
+        learning_path.duration = f"{learning_path.duration_in_days} days"
+        learning_path.save()
+
+
+def reverse_transfer_duration_data(apps, schema_editor):
+    """Reverse operation: extract numeric values from duration field back to duration_in_days."""
+    LearningPath = apps.get_model("learning_paths", "LearningPath")
+
+    for learning_path in LearningPath.objects.filter(duration__endswith=" days"):
+        try:
+            days_str = learning_path.duration.replace(" days", "")
+            learning_path.duration_in_days = int(days_str)
+            learning_path.save()
+        except ValueError:
+            # Skip entries that don't match the expected format.
+            pass
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("learning_paths", "0013_enrollment_audit"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="learningpath",
+            name="duration",
+            field=models.CharField(
+                blank=True,
+                help_text="Approximate time it should take to complete this Learning Path. Example: '10 Weeks'.",
+                max_length=255,
+            ),
+        ),
+        migrations.AddField(
+            model_name="learningpath",
+            name="time_commitment",
+            field=models.CharField(
+                blank=True, help_text="Approximate time commitment. Example: '4-6 hours/week'.", max_length=255
+            ),
+        ),
+        migrations.RunPython(
+            transfer_duration_data,
+            reverse_transfer_duration_data,
+        ),
+        migrations.RemoveField(
+            model_name="learningpath",
+            name="duration_in_days",
+        ),
+    ]

learning_paths_plugin-0.3.4rc9/learning_paths/migrations/0015_make_skill_level_optional.py

@@ -0,0 +1,27 @@
+# Generated by Django 4.2.23 on 2025-07-22 22:28
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("learning_paths", "0014_remove_learningpath_duration_in_days_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="acquiredskill",
+            name="level",
+            field=models.PositiveIntegerField(
+                blank=True, help_text="The skill level associated with this course.", null=True
+            ),
+        ),
+        migrations.AlterField(
+            model_name="requiredskill",
+            name="level",
+            field=models.PositiveIntegerField(
+                blank=True, help_text="The skill level associated with this course.", null=True
+            ),
+        ),
+    ]

{learning_paths_plugin-0.3.4rc6 → learning_paths_plugin-0.3.4rc9}/learning_paths/models.py

@@ -5,14 +5,14 @@ Database models for learning_paths.
 import logging
 import os
 import uuid
-from datetime import datetime, timedelta
+from datetime import datetime
 from uuid import uuid4
 
 from django.contrib import auth
 from django.core.exceptions import ValidationError
 from django.core.validators import MaxValueValidator, MinValueValidator
 from django.db import models
-from django.db.models import Exists, OuterRef, Q
+from django.db.models import OuterRef, Q
 from django.utils.translation import gettext_lazy as _
 from model_utils import FieldTracker
 from model_utils.models import TimeStampedModel
@@ -38,27 +38,29 @@ class LearningPathManager(models.Manager):
 
     def get_paths_visible_to_user(self, user: User) -> models.QuerySet:
         """
-        Return only learning paths that should be visible to the given user with enrollment status.
+        Return only learning paths that should be visible to the given user with an enrollment date.
 
         For staff users: all learning paths.
         For non-staff: non-invite-only paths or invite-only paths they're enrolled in.
 
-        Each learning path in the queryset is annotated with `is_enrolled` indicating
-        whether the user has an active enrollment in that learning path.
+        Each learning path in the queryset is annotated with `enrollment_date` indicating
+        the date when the user enrolled in that learning path (None if not enrolled).
+        Results are ordered by enrollment date (the most recent first), with non-enrolled paths at the end.
         """
         queryset = self.get_queryset()
 
-        # Annotate each path with whether the user is enrolled.
-        enrollment_exists = LearningPathEnrollment.objects.filter(
+        # Annotate each path with the enrollment date.
+        enrollment_subquery = LearningPathEnrollment.objects.filter(
             learning_path=OuterRef("pk"), user=user, is_active=True
-        )
-        queryset = queryset.annotate(is_enrolled=Exists(enrollment_exists))
+        ).values("created")[:1]
+        queryset = queryset.annotate(enrollment_date=models.Subquery(enrollment_subquery))
 
         # Apply visibility filtering based on the user role.
         if not user.is_staff:
-            queryset = queryset.filter(Q(invite_only=False) | Q(is_enrolled=True))
+            queryset = queryset.filter(Q(invite_only=False) | Q(enrollment_date__isnull=False))
 
-        return queryset
+        # Order by enrollment date (the most recent first), with null values at the end.
+        return queryset.order_by(models.F("enrollment_date").desc(nulls_last=True))
 
 
 class LearningPath(TimeStampedModel):
@@ -102,18 +104,22 @@ class LearningPath(TimeStampedModel):
     subtitle = models.TextField(blank=True)
     description = models.TextField(blank=True)
     image = models.ImageField(
-        upload_to=_learning_path_image_upload_path,
+        upload_to=_learning_path_image_upload_path,  # type: ignore
         blank=True,
         null=True,
         verbose_name=_("Image"),
         help_text=_("Image representing this Learning Path."),
     )
     level = models.CharField(max_length=255, blank=True, choices=LEVEL_CHOICES)
-    duration_in_days = models.PositiveIntegerField(
+    duration = models.CharField(
+        max_length=255,
         blank=True,
-        null=True,
-        verbose_name=_("Duration (days)"),
-        help_text=_("Approximate time (in days) it should take to complete this Learning Path."),
+        help_text=_("Approximate time it should take to complete this Learning Path. Example: '10 Weeks'."),
+    )
+    time_commitment = models.CharField(
+        max_length=255,
+        blank=True,
+        help_text=_("Approximate time commitment. Example: '4-6 hours/week'."),
     )
     sequential = models.BooleanField(
         default=False,
@@ -134,6 +140,11 @@ class LearningPath(TimeStampedModel):
 
     objects = LearningPathManager()
 
+    steps: "models.Manager[LearningPathStep]"
+    requiredskill_set: "models.Manager[RequiredSkill]"
+    acquiredskill_set: "models.Manager[AcquiredSkill]"
+    grading_criteria: "LearningPathGradingCriteria"
+
     def __str__(self):
         """User-friendly string representation of this model."""
         return str(self.key)
@@ -248,7 +259,11 @@ class LearningPathSkill(TimeStampedModel):
 
     learning_path = models.ForeignKey(LearningPath, on_delete=models.CASCADE)
     skill = models.ForeignKey(Skill, on_delete=models.CASCADE)
-    level = models.PositiveIntegerField(help_text=_("The skill level associated with this course."))
+    level = models.PositiveIntegerField(
+        blank=True,
+        null=True,
+        help_text=_("The skill level associated with this course."),
+    )
 
     def __str__(self):
         """User-friendly string representation of this model."""
@@ -289,25 +304,12 @@ class LearningPathEnrollment(TimeStampedModel):
         default=True,
         help_text=_("Indicates if the learner is enrolled or not in the Learning Path"),
     )
-    enrolled_at = models.DateTimeField(
-        auto_now_add=True,
-        help_text=_(
-            "Timestamp of enrollment or un-enrollment. To be explicitly set when performing a learner enrollment."
-        ),
-    )
     tracker = FieldTracker(fields=["is_active"])
 
     def __str__(self):
         """User-friendly string representation of this model."""
         return "{}: {}".format(self.user, self.learning_path)
 
-    @property
-    def estimated_end_date(self):
-        """Estimated end date of the learning path."""
-        if self.learning_path.duration_in_days is None:
-            return None
-        return self.created + timedelta(days=self.learning_path.duration_in_days)
-
 
 class LearningPathGradingCriteria(models.Model):
     """
@@ -373,7 +375,9 @@ class LearningPathEnrollmentAllowed(TimeStampedModel):
     learning_path = models.ForeignKey(LearningPath, on_delete=models.CASCADE)
     user = models.ForeignKey(User, on_delete=models.CASCADE, blank=True, null=True)
     is_active = models.BooleanField(
-        default=True, db_index=True, help_text=_("Indicates if the enrollment allowance is active")
+        default=True,
+        db_index=True,
+        help_text=_("Indicates if the enrollment allowance is active"),
     )
 
     def __str__(self):
@@ -410,9 +414,17 @@ class LearningPathEnrollmentAudit(TimeStampedModel):
     )
 
     enrolled_by = models.ForeignKey(User, on_delete=models.CASCADE, null=True, related_name="learning_path_audit")
-    enrollment = models.ForeignKey(LearningPathEnrollment, on_delete=models.CASCADE, null=True, related_name="audit")
+    enrollment = models.ForeignKey(
+        LearningPathEnrollment,
+        on_delete=models.CASCADE,
+        null=True,
+        related_name="audit",
+    )
     enrollment_allowed = models.ForeignKey(
-        LearningPathEnrollmentAllowed, on_delete=models.CASCADE, null=True, related_name="audit"
+        LearningPathEnrollmentAllowed,
+        on_delete=models.CASCADE,
+        null=True,
+        related_name="audit",
     )
     state_transition = models.CharField(max_length=255, choices=TRANSITION_STATES, default=DEFAULT_TRANSITION_STATE)
     reason = models.TextField(blank=True)

{learning_paths_plugin-0.3.4rc6 → learning_paths_plugin-0.3.4rc9/learning_paths_plugin.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-paths-plugin
-Version: 0.3.4rc6
+Version: 0.3.4rc9
 Summary: Learning Paths plugin
 Home-page: https://github.com/open-craft/learning-paths-plugin
 Author: OpenCraft
@@ -18,6 +18,7 @@ Requires-Python: >=3.11
 License-File: LICENSE.txt
 Requires-Dist: Django
 Requires-Dist: django-model-utils
+Requires-Dist: django-object-actions
 Requires-Dist: djangorestframework
 Requires-Dist: edx-django-utils
 Requires-Dist: edx-opaque-keys
@@ -128,11 +129,16 @@ Added
 
 * Bulk unenrollment API.
 * Enrollment audit model that tracks the enrollment state transitions.
+* Allow specifying time commitment.
+* Allow duplicating Learning Paths in the Django admin interface.
 
 Changed
 =======
 
 * The Learning Paths API includes start and end dates for its steps.
+* Return enrollment date in the API instead of a boolean.
+* Allow specifying any text for the duration.
+* Make the skill level optional.
 
 0.3.3 - 2025-05-23
 ******************

{learning_paths_plugin-0.3.4rc6 → learning_paths_plugin-0.3.4rc9}/learning_paths_plugin.egg-info/SOURCES.txt

@@ -37,7 +37,8 @@ learning_paths/migrations/0010_learningpath_invite_only.py
 learning_paths/migrations/0011_replace_learningpath_image_url_with_image.py
 learning_paths/migrations/0012_alter_learningpath_subtitle.py
 learning_paths/migrations/0013_enrollment_audit.py
-learning_paths/migrations/0014_learningpathenrollmentallowed_is_active.py
+learning_paths/migrations/0014_remove_learningpath_duration_in_days_and_more.py
+learning_paths/migrations/0015_make_skill_level_optional.py
 learning_paths/migrations/__init__.py
 learning_paths/templates/learning_paths/base.html
 learning_paths_plugin.egg-info/PKG-INFO

{learning_paths_plugin-0.3.4rc6 → learning_paths_plugin-0.3.4rc9}/learning_paths_plugin.egg-info/requires.txt

@@ -1,5 +1,6 @@
 Django
 django-model-utils
+django-object-actions
 djangorestframework
 edx-django-utils
 edx-opaque-keys

{learning_paths_plugin-0.3.4rc6 → learning_paths_plugin-0.3.4rc9}/requirements/base.in

@@ -4,6 +4,7 @@
 Django             # Web application framework
 
 django-model-utils
+django-object-actions          # Add action buttons to Django admin
 djangorestframework
 edx-django-utils
 edx-opaque-keys

learning_paths_plugin-0.3.4rc6/learning_paths/migrations/0014_learningpathenrollmentallowed_is_active.py

@@ -1,20 +0,0 @@
-# Generated by Django 4.2.20 on 2025-05-30 19:57
-
-from django.db import migrations, models
-
-
-class Migration(migrations.Migration):
-
-    dependencies = [
-        ("learning_paths", "0013_enrollment_audit"),
-    ]
-
-    operations = [
-        migrations.AddField(
-            model_name="learningpathenrollmentallowed",
-            name="is_active",
-            field=models.BooleanField(
-                db_index=True, default=True, help_text="Indicates if the enrollment allowance is active"
-            ),
-        ),
-    ]