learning-paths-plugin 0.3.1__tar.gz → 0.3.3__tar.gz

{learning_paths_plugin-0.3.1 → learning_paths_plugin-0.3.3}/CHANGELOG.rst

@@ -16,6 +16,40 @@ Unreleased
 
 *
 
+0.3.3 - 2025-05-23
+******************
+
+Changed
+=======
+
+* Changed line length from 80 to 120 characters.
+
+0.3.2 - 2025-05-02
+******************
+
+Added
+=====
+
+* Course key selection in admin forms.
+* Learning Path selection field in admin forms.
+* Enrollment status to the Learning Path list and retrieve APIs.
+* Invite-only functionality for Learning Paths.
+* Course enrollment API.
+
+Changed
+=======
+
+* The Learning Path ``subtitle`` to ``TextField`` and made it optional.
+* The image URL field to ``ImageField``.
+* The user field on the admin enrollments page to raw ID, to prevent the page
+  from retrieving all users in the system.
+
+Removed
+=======
+
+* The ``slug`` field from the Learning Path model.
+* The UUID compatibility layer from Learning Path keys.
+
 0.3.1 - 2025-04-14
 ******************
 

{learning_paths_plugin-0.3.1/learning_paths_plugin.egg-info → learning_paths_plugin-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-paths-plugin
-Version: 0.3.1
+Version: 0.3.3
 Summary: Learning Paths plugin
 Home-page: https://github.com/open-craft/learning-paths-plugin
 Author: OpenCraft
@@ -24,6 +24,7 @@ Requires-Dist: edx-django-utils
 Requires-Dist: edx-opaque-keys
 Requires-Dist: openedx-atlas
 Requires-Dist: openedx-completion-aggregator
+Requires-Dist: pillow
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -120,6 +121,40 @@ Unreleased
 
 *
 
+0.3.3 - 2025-05-23
+******************
+
+Changed
+=======
+
+* Changed line length from 80 to 120 characters.
+
+0.3.2 - 2025-05-02
+******************
+
+Added
+=====
+
+* Course key selection in admin forms.
+* Learning Path selection field in admin forms.
+* Enrollment status to the Learning Path list and retrieve APIs.
+* Invite-only functionality for Learning Paths.
+* Course enrollment API.
+
+Changed
+=======
+
+* The Learning Path ``subtitle`` to ``TextField`` and made it optional.
+* The image URL field to ``ImageField``.
+* The user field on the admin enrollments page to raw ID, to prevent the page
+  from retrieving all users in the system.
+
+Removed
+=======
+
+* The ``slug`` field from the Learning Path model.
+* The UUID compatibility layer from Learning Path keys.
+
 0.3.1 - 2025-04-14
 ******************
 

{learning_paths_plugin-0.3.1 → learning_paths_plugin-0.3.3}/learning_paths/__init__.py

@@ -2,4 +2,4 @@
 Learning Paths plugin.
 """
 
-__version__ = "0.3.1"
+__version__ = "0.3.3"

{learning_paths_plugin-0.3.1 → learning_paths_plugin-0.3.3}/learning_paths/admin.py

@@ -29,13 +29,55 @@ def get_course_keys_choices():
         yield key, key
 
 
+class CourseKeyDatalistWidget(forms.TextInput):
+    """A widget that provides a datalist for course keys."""
+
+    def __init__(self, choices=None, attrs=None):
+        """Initialize the widget with a datalist and apply styles."""
+        attrs = attrs or {}
+        attrs.update(
+            {
+                "style": "width: 30em;",
+                "class": "form-control datalist-input",
+                "placeholder": _("Type to search courses..."),
+            }
+        )
+        super().__init__(attrs)
+        self.choices = choices or []
+
+    def render(self, name, value, attrs=None, renderer=None):
+        """Render the widget with a datalist."""
+        final_attrs = attrs or {}
+        data_list_id = f"datalist_{name}"
+        final_attrs["list"] = data_list_id
+
+        text_input_html = super().render(name, value, attrs, renderer)
+        data_list_id = f"datalist_{name}"
+        options = "\n".join(f'<option value="{choice}" />' for choice in self.choices)
+        datalist_html = f'<datalist id="{data_list_id}">\n{options}\n</datalist>'
+        return f"{text_input_html}\n{datalist_html}"
+
+
 class LearningPathStepForm(forms.ModelForm):
-    """Admin form for Learning Path step."""
+    """Form for Learning Path step."""
+
+    def __init__(self, *args, **kwargs):
+        """Lazily fetch course keys to avoid calling compat code in all environments."""
+        super().__init__(*args, **kwargs)
+        self._course_keys = get_course_keys_with_outlines()
+        self.fields["course_key"].widget = CourseKeyDatalistWidget(choices=self._course_keys)
+
+    course_key = forms.CharField(label=_("Course"))
+
+    def clean_course_key(self):
+        """Validate that the course key is on the list of available course keys."""
+        course_key = self.cleaned_data.get("course_key")
+        valid_keys = {str(key).strip() for key in self._course_keys}
+
+        if course_key not in valid_keys:
+            raise ValidationError(_("Invalid course key. Please select a course from the suggestions."))
 
-    # TODO: Use autocomplete select instead.
-    # See <https://github.com/open-craft/section-to-course/blob/db6fd6f8f4478e91bb531e6c2fa50143e1c2e012/
-    #      section_to_course/admin.py#L31-L140>
-    course_key = forms.ChoiceField(choices=get_course_keys_choices, label=_("Course"))
+        return course_key
 
 
 class LearningPathStepInline(admin.TabularInline):
@@ -89,9 +131,7 @@ class BulkEnrollUsersForm(forms.ModelForm):
         found_usernames = list(users.values_list("username", flat=True))
         invalid_usernames = set(usernames) - set(found_usernames)
         if invalid_usernames:
-            raise ValidationError(
-                f"The following usernames are not valid: {', '.join(invalid_usernames)}"
-            )
+            raise ValidationError(f"The following usernames are not valid: {', '.join(invalid_usernames)}")
         return users
 
 
@@ -102,17 +142,17 @@ class LearningPathAdmin(admin.ModelAdmin):
     form = BulkEnrollUsersForm
 
     search_fields = [
-        "slug",
         "display_name",
         "key",
     ]
     list_display = (
         "key",
-        "slug",
         "display_name",
         "level",
         "duration_in_days",
+        "invite_only",
     )
+    list_filter = ("invite_only",)
     readonly_fields = ("key",)
 
     inlines = [
@@ -133,9 +173,7 @@ class LearningPathAdmin(admin.ModelAdmin):
         super().save_related(request, form, formsets, change)
         with transaction.atomic():
             for user in form.cleaned_data["usernames"]:
-                LearningPathEnrollment.objects.get_or_create(
-                    user=user, learning_path=form.instance
-                )
+                LearningPathEnrollment.objects.get_or_create(user=user, learning_path=form.instance)
 
 
 class SkillAdmin(admin.ModelAdmin):
@@ -148,12 +186,13 @@ class EnrolledUsersAdmin(admin.ModelAdmin):
     """Admin for Learning Path enrollment."""
 
     model = LearningPathEnrollment
+    raw_id_fields = ("user",)
+    autocomplete_fields = ["learning_path"]
 
     search_fields = [
         "id",
         "user__username",
         "learning_path__key",
-        "learning_path__slug",
         "learning_path__display_name",
     ]
 

{learning_paths_plugin-0.3.1 → learning_paths_plugin-0.3.3}/learning_paths/api/v1/serializers.py

@@ -35,15 +35,15 @@ class LearningPathAsProgramSerializer(serializers.ModelSerializer):
     course_codes = serializers.SerializerMethodField()
 
     def get_marketing_slug(self, obj):
-        return obj.slug
+        return str(obj.key)
 
     def get_status(self, obj):  # pylint: disable=unused-argument
         return DEFAULT_STATUS
 
     def get_banner_image_urls(self, obj):
-        if obj.image_url:
+        if obj.image:
             image_key = f"w{IMAGE_WIDTH}h{IMAGE_HEIGHT}"
-            return {image_key: obj.image_url}
+            return {image_key: obj.image.url}
         return {}
 
     def get_organizations(self, obj):  # pylint: disable=unused-argument
@@ -104,22 +104,32 @@ class LearningPathListSerializer(serializers.ModelSerializer):
     """Serializer for the learning path list."""
 
     steps = LearningPathStepSerializer(many=True, read_only=True)
-    required_completion = serializers.FloatField(
-        source="grading_criteria.required_completion", read_only=True
-    )
+    required_completion = serializers.FloatField(source="grading_criteria.required_completion", read_only=True)
+    is_enrolled = serializers.SerializerMethodField()
+    invite_only = serializers.BooleanField()
+    image = serializers.ImageField(read_only=True)
 
     class Meta:
         model = LearningPath
         fields = [
             "key",
-            "slug",
             "display_name",
-            "image_url",
+            "image",
             "sequential",
             "steps",
             "required_completion",
+            "is_enrolled",
+            "invite_only",
         ]
 
+    def get_is_enrolled(self, obj):
+        """
+        Check if the current user is enrolled in this learning path.
+        """
+        if hasattr(obj, "is_enrolled"):
+            return obj.is_enrolled
+        return False
+
 
 class SkillSerializer(serializers.ModelSerializer):
     class Meta:
@@ -151,38 +161,22 @@ class AcquiredSkillSerializer(serializers.ModelSerializer):
         fields = ["skill", "level"]
 
 
-class LearningPathDetailSerializer(serializers.ModelSerializer):
+class LearningPathDetailSerializer(LearningPathListSerializer):
     """
     Serializer for learning path details.
     """
 
-    steps = LearningPathStepSerializer(many=True, read_only=True)
-    required_skills = RequiredSkillSerializer(
-        source="requiredskill_set", many=True, read_only=True
-    )
-    acquired_skills = AcquiredSkillSerializer(
-        source="acquiredskill_set", many=True, read_only=True
-    )
-    required_completion = serializers.FloatField(
-        source="grading_criteria.required_completion", read_only=True
-    )
+    required_skills = RequiredSkillSerializer(source="requiredskill_set", many=True, read_only=True)
+    acquired_skills = AcquiredSkillSerializer(source="acquiredskill_set", many=True, read_only=True)
 
-    class Meta:
-        model = LearningPath
-        fields = [
-            "key",
-            "slug",
-            "display_name",
+    class Meta(LearningPathListSerializer.Meta):
+        fields = LearningPathListSerializer.Meta.fields + [
             "subtitle",
             "description",
-            "image_url",
             "level",
             "duration_in_days",
-            "sequential",
-            "steps",
             "required_skills",
             "acquired_skills",
-            "required_completion",
         ]
 
 

{learning_paths_plugin-0.3.1 → learning_paths_plugin-0.3.3}/learning_paths/api/v1/urls.py

@@ -6,18 +6,17 @@ from rest_framework import routers
 from learning_paths.api.v1.views import (
     BulkEnrollView,
     LearningPathAsProgramViewSet,
+    LearningPathCourseEnrollmentView,
     LearningPathEnrollmentView,
     LearningPathUserGradeView,
     LearningPathUserProgressView,
     LearningPathViewSet,
     ListEnrollmentsView,
 )
-from learning_paths.keys import LEARNING_PATH_URL_PATTERN
+from learning_paths.keys import COURSE_KEY_URL_PATTERN, LEARNING_PATH_URL_PATTERN
 
 router = routers.SimpleRouter()
-router.register(
-    r"programs", LearningPathAsProgramViewSet, basename="learning-path-as-program"
-)
+router.register(r"programs", LearningPathAsProgramViewSet, basename="learning-path-as-program")
 router.register(r"learning-paths", LearningPathViewSet, basename="learning-path")
 
 urlpatterns = router.urls + [
@@ -32,7 +31,7 @@ urlpatterns = router.urls + [
         name="learning-path-grade",
     ),
     re_path(
-        rf"{LEARNING_PATH_URL_PATTERN}/enrollments/",
+        rf"{LEARNING_PATH_URL_PATTERN}/enrollments/$",
         LearningPathEnrollmentView.as_view(),
         name="learning-path-enrollments",
     ),
@@ -46,4 +45,9 @@ urlpatterns = router.urls + [
         BulkEnrollView.as_view(),
         name="bulk-enroll",
     ),
+    re_path(
+        rf"{LEARNING_PATH_URL_PATTERN}/enrollments/{COURSE_KEY_URL_PATTERN}/",
+        LearningPathCourseEnrollmentView.as_view(),
+        name="learning-path-course-enroll",
+    ),
 ]

{learning_paths_plugin-0.3.1 → learning_paths_plugin-0.3.3}/learning_paths/api/v1/utils.py

@@ -29,9 +29,7 @@ def get_course_completion(username: str, course_key: CourseKey, client: Any) ->
         if err.response.status_code == 404:
             return 0.0
         else:
-            raise APIException(
-                f"Error fetching completion for course {course_id}: {err}"
-            ) from err
+            raise APIException(f"Error fetching completion for course {course_id}: {err}") from err
 
     if data and data.get("results"):
         return data["results"][0]["completion"]["percent"]
@@ -51,9 +49,7 @@ def get_aggregate_progress(user, learning_path):
     total_completion = 0.0
 
     for step in steps:
-        course_completion = get_course_completion(
-            user.username, step.course_key, client
-        )
+        course_completion = get_course_completion(user.username, step.course_key, client)
         total_completion += course_completion
 
     total_courses = len(steps)

{learning_paths_plugin-0.3.1 → learning_paths_plugin-0.3.3}/learning_paths/api/v1/views.py

@@ -11,8 +11,9 @@ from django.core.exceptions import ObjectDoesNotExist, PermissionDenied, Validat
 from django.core.validators import validate_email
 from django.shortcuts import get_object_or_404
 from opaque_keys import InvalidKeyError
+from opaque_keys.edx.keys import CourseKey
 from rest_framework import generics, status, viewsets
-from rest_framework.exceptions import NotFound
+from rest_framework.exceptions import NotFound, ParseError
 from rest_framework.pagination import PageNumberPagination
 from rest_framework.permissions import IsAdminUser, IsAuthenticated
 from rest_framework.response import Response
@@ -26,6 +27,7 @@ from learning_paths.api.v1.serializers import (
     LearningPathListSerializer,
     LearningPathProgressSerializer,
 )
+from learning_paths.compat import enroll_user_in_course
 from learning_paths.keys import LearningPathKey
 from learning_paths.models import (
     LearningPath,
@@ -51,11 +53,14 @@ class LearningPathAsProgramViewSet(viewsets.ReadOnlyModelViewSet):
     https://github.com/openedx/course-discovery/blob/d6a57fd69479b3d5f5afb682d2668b58503a6af6/course_discovery/apps/course_metadata/data_loaders/api.py#L843
     """
 
-    queryset = LearningPath.objects.all()
     permission_classes = (IsAuthenticated,)
     serializer_class = LearningPathAsProgramSerializer
     pagination_class = PageNumberPagination
 
+    def get_queryset(self):
+        """Get the learning paths visible to the current user."""
+        return LearningPath.objects.get_paths_visible_to_user(self.request.user)
+
 
 class LearningPathUserProgressView(APIView):
     """
@@ -68,8 +73,10 @@ class LearningPathUserProgressView(APIView):
         """
         Fetch the learning path progress
         """
-        learning_path_key = LearningPathKey.from_string(learning_path_key_str)
-        learning_path = get_object_or_404(LearningPath, key=learning_path_key)
+        learning_path = get_object_or_404(
+            LearningPath.objects.get_paths_visible_to_user(self.request.user),
+            key=learning_path_key_str,
+        )
 
         progress = get_aggregate_progress(request.user, learning_path)
         required_completion = None
@@ -80,7 +87,7 @@ class LearningPathUserProgressView(APIView):
             pass
 
         data = {
-            "learning_path_key": str(learning_path_key),
+            "learning_path_key": learning_path_key_str,
             "progress": progress,
             "required_completion": required_completion,
         }
@@ -103,8 +110,10 @@ class LearningPathUserGradeView(APIView):
         Fetch learning path grade
         """
 
-        learning_path_key = LearningPathKey.from_string(learning_path_key_str)
-        learning_path = get_object_or_404(LearningPath, key=learning_path_key)
+        learning_path = get_object_or_404(
+            LearningPath.objects.get_paths_visible_to_user(self.request.user),
+            key=learning_path_key_str,
+        )
 
         try:
             grading_criteria = learning_path.grading_criteria
@@ -117,7 +126,7 @@ class LearningPathUserGradeView(APIView):
         grade = grading_criteria.calculate_grade(request.user)
 
         data = {
-            "learning_path_key": str(learning_path_key),
+            "learning_path_key": learning_path_key_str,
             "grade": grade,
             "required_grade": grading_criteria.required_grade,
         }
@@ -134,11 +143,21 @@ class LearningPathViewSet(viewsets.ReadOnlyModelViewSet):
     including steps and associated skills.
     """
 
-    queryset = LearningPath.objects.prefetch_related("steps", "grading_criteria")
     permission_classes = (IsAuthenticated,)
     pagination_class = PageNumberPagination
     lookup_field = "key"
 
+    def get_queryset(self):
+        """
+        Get all learning paths and prefetch the related data.
+        """
+        user = self.request.user
+        queryset = LearningPath.objects.get_paths_visible_to_user(user).prefetch_related(
+            "steps",
+            "grading_criteria",
+        )
+        return queryset
+
     def get_serializer_class(self):
         if self.action == "list":
             return LearningPathListSerializer
@@ -159,6 +178,17 @@ class LearningPathEnrollmentView(APIView):
 
     permission_classes = [IsAuthenticated, IsAdminOrSelf]
 
+    def _get_learning_path(self, learning_path_key_str: str) -> LearningPath:
+        """
+        Get the learning path and verify user has access to it.
+
+        :raises: Http404 if the learning path is not found or user does not have access.
+        """
+        return get_object_or_404(
+            LearningPath.objects.get_paths_visible_to_user(self.request.user),
+            key=learning_path_key_str,
+        )
+
     def get(self, request, learning_path_key_str: str):
         """Get the learning path of users.
 
@@ -169,12 +199,9 @@ class LearningPathEnrollmentView(APIView):
             username (optional): When provided it returns the enrollment for
                 the specified user.
         """
-        learning_path_key = LearningPathKey.from_string(learning_path_key_str)
-        learning_path = get_object_or_404(LearningPath, key=learning_path_key)
+        learning_path = self._get_learning_path(learning_path_key_str)
 
-        enrollments = LearningPathEnrollment.objects.filter(
-            learning_path=learning_path, is_active=True
-        )
+        enrollments = LearningPathEnrollment.objects.filter(learning_path=learning_path, is_active=True)
 
         if request.user.is_staff:
             if username := request.query_params.get("username"):
@@ -189,7 +216,7 @@ class LearningPathEnrollmentView(APIView):
         """Enroll learners in Learning Paths.
 
         Staff/Admin can enroll anyone with the username query param.
-        Learners can enroll only themselves.
+        Learners can enroll only themselves, and only if the learning path is not invite-only.
 
         Example payload::
 
@@ -198,23 +225,18 @@ class LearningPathEnrollmentView(APIView):
             }
 
         """
-        learning_path_key = LearningPathKey.from_string(learning_path_key_str)
-        learning_path = get_object_or_404(LearningPath, key=learning_path_key)
+        learning_path = self._get_learning_path(learning_path_key_str)
         username = request.data.get("username")
         user = get_object_or_404(User, username=username) if username else request.user
 
-        enrollment, created = LearningPathEnrollment.objects.get_or_create(
-            learning_path=learning_path, user=user
-        )
+        enrollment, created = LearningPathEnrollment.objects.get_or_create(learning_path=learning_path, user=user)
         if created:
             return Response(
                 LearningPathEnrollmentSerializer(enrollment).data,
                 status=status.HTTP_201_CREATED,
             )
         if enrollment.is_active:
-            return Response(
-                {"detail": "Enrollment exists."}, status=status.HTTP_409_CONFLICT
-            )
+            return Response({"detail": "Enrollment exists."}, status=status.HTTP_409_CONFLICT)
 
         enrollment.is_active = True
         enrollment.enrolled_at = datetime.now(timezone.utc)
@@ -235,8 +257,7 @@ class LearningPathEnrollmentView(APIView):
             }
 
         """
-        learning_path_key = LearningPathKey.from_string(learning_path_key_str)
-        learning_path = get_object_or_404(LearningPath, key=learning_path_key)
+        learning_path = self._get_learning_path(learning_path_key_str)
         username = request.data.get("username")
         user = get_object_or_404(User, username=username) if username else request.user
 
@@ -247,10 +268,7 @@ class LearningPathEnrollmentView(APIView):
             user=user,
         )
 
-        if (
-            not request.user.is_staff
-            and not settings.LEARNING_PATHS_ALLOW_SELF_UNENROLLMENT
-        ):
+        if not request.user.is_staff and not settings.LEARNING_PATHS_ALLOW_SELF_UNENROLLMENT:
             raise PermissionDenied
 
         enrollment.is_active = False
@@ -331,9 +349,7 @@ class BulkEnrollView(APIView):
 
             # Create LearningPathEnrollment for existing users
             for user in existing_users:
-                enrollment = LearningPathEnrollment.objects.filter(
-                    user=user, learning_path=learning_path
-                ).first()
+                enrollment = LearningPathEnrollment.objects.filter(user=user, learning_path=learning_path).first()
                 enrolled_now = False
                 if not enrollment:
                     enrollment = LearningPathEnrollment(
@@ -369,3 +385,40 @@ class BulkEnrollView(APIView):
             },
             status=status.HTTP_201_CREATED,
         )
+
+
+class LearningPathCourseEnrollmentView(APIView):
+    """API View to enroll a user in a course that's part of a learning path."""
+
+    permission_classes = [IsAuthenticated, IsAdminOrSelf]
+
+    def _get_enrolled_learning_path(self, learning_path_key_str: str) -> LearningPath:
+        """
+        Get the learning path and verify the user has access and is enrolled.
+
+        :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),
+            key=learning_path_key_str,
+        )
+
+    def post(self, request, learning_path_key_str: str, course_key_str: str):
+        """
+        Enroll a user in a course that's part of a learning path.
+
+        The user must be enrolled in the learning path, and the course must be a step in the path.
+        """
+        learning_path = self._get_enrolled_learning_path(learning_path_key_str)
+        course_key = CourseKey.from_string(course_key_str)
+
+        if not learning_path.steps.filter(course_key=course_key).exists():
+            raise ParseError("The course is not part of this learning path.")
+
+        if enroll_user_in_course(request.user, course_key):
+            return Response(
+                {"detail": "User successfully enrolled in the course."},
+                status=status.HTTP_201_CREATED,
+            )
+        else:
+            raise ParseError("Failed to enroll the user in the course.")

{learning_paths_plugin-0.3.1 → learning_paths_plugin-0.3.3}/learning_paths/compat.py

@@ -2,11 +2,14 @@
 Compatibility layer for testing without Open edX.
 """
 
+import logging
 from datetime import datetime
 
 from django.contrib.auth.models import AbstractBaseUser
 from opaque_keys.edx.keys import CourseKey
 
+log = logging.getLogger(__name__)
+
 
 def get_user_course_grade(user: AbstractBaseUser, course_key: CourseKey):
     """
@@ -31,7 +34,7 @@ def get_catalog_api_client(user: AbstractBaseUser):
     return api_client(user)
 
 
-def get_course_keys_with_outlines():
+def get_course_keys_with_outlines() -> list[CourseKey]:
     """
     Retrieve course keys.
     """
@@ -57,9 +60,17 @@ def get_course_due_date(course_key: CourseKey) -> datetime | None:
         return None
 
 
-__all__ = [
-    "get_course_keys_with_outlines",
-    "get_catalog_api_client",
-    "get_user_course_grade",
-    "get_course_due_date",
-]
+def enroll_user_in_course(user: AbstractBaseUser, course_key: CourseKey) -> bool:
+    """Enroll a user in a course."""
+    # pylint: disable=import-outside-toplevel, import-error
+    from common.djangoapps.student.api import CourseEnrollment
+    from common.djangoapps.student.models.course_enrollment import (
+        CourseEnrollmentException,
+    )
+
+    try:
+        CourseEnrollment.enroll(user, course_key)
+        return True
+    except CourseEnrollmentException as exc:
+        log.exception("Failed to enroll user %s in course %s: %s", user, course_key, exc)
+        return False