learning-paths-plugin 0.2.3__tar.gz

learning_paths_plugin-0.2.3/CHANGELOG.rst

@@ -0,0 +1,50 @@
+Change Log
+##########
+
+..
+   All enhancements and patches to learning_paths will be documented
+   in this file.  It adheres to the structure of https://keepachangelog.com/ ,
+   but in reStructuredText instead of Markdown (for ease of incorporation into
+   Sphinx documentation and the PyPI description).
+
+   This project adheres to Semantic Versioning (https://semver.org/).
+
+.. There should always be an "Unreleased" section for changes pending release.
+
+Unreleased
+**********
+
+*
+
+0.2.3 - 2025-03-31
+******************
+
+Added
+=====
+
+* Enrollment API.
+
+0.2.2 - 2024-12-05
+******************
+
+Added
+=====
+
+* User grade API
+
+0.2.1 - 2024-10-28
+******************
+
+Added
+=====
+
+* Pathway progress API
+
+0.2.0 - 2024-01-23
+******************
+
+Added
+=====
+
+* Database models
+* Django Admin interface

learning_paths_plugin-0.2.3/LICENSE.txt

@@ -0,0 +1 @@
+

learning_paths_plugin-0.2.3/MANIFEST.in

@@ -0,0 +1,6 @@
+include CHANGELOG.rst
+include LICENSE.txt
+include README.rst
+include requirements/base.in
+include requirements/constraints.txt
+recursive-include learning_paths *.html *.png *.gif *.js *.css *.jpg *.jpeg *.svg

learning_paths_plugin-0.2.3/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: learning-paths-plugin
+Version: 0.2.3
+Summary: Learning Paths plugin
+Home-page: https://github.com/open-craft/learning-paths-plugin
+Author: OpenCraft
+Author-email: help@opencraft.com
+Keywords: Python edx
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Intended Audience :: Developers
+Classifier: License :: Other/Proprietary License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.11
+License-File: LICENSE.txt
+Requires-Dist: Django
+Requires-Dist: django-model-utils
+Requires-Dist: django-simple-history==3.4.0
+Requires-Dist: djangorestframework
+Requires-Dist: edx-django-utils
+Requires-Dist: edx-opaque-keys
+Requires-Dist: openedx-atlas
+Requires-Dist: openedx-completion-aggregator
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+learning-paths-plugin
+#####################
+
+Purpose
+*******
+
+A Learning Path consists of a selection of courses bundled together for
+learners to progress through. This plugin enables the creation and
+management of Learning Paths.
+
+License
+*******
+
+The code in this repository is licensed under the Not open source unless
+otherwise noted.
+
+Please see `LICENSE.txt <LICENSE.txt>`_ for details.
+
+Installation and Configuration
+******************************
+
+1. **Clone the Repository**
+
+   Clone the repository containing the plugin to the `src` directory under your devstack root:
+
+   .. code-block:: bash
+
+      git clone <repository_url> <devstack_root>/src/learning-paths-plugin
+
+2. **Install the Plugin**
+
+   Inside the LMS shell, install the plugin by running:
+
+   .. code-block:: bash
+
+      pip install -e /edx/src/learning-paths-plugin/
+
+3. **Run Migrations for the Plugin**
+
+   After installing the plugin, run the database migrations for `learning_paths`:
+
+   .. code-block:: bash
+
+      ./manage.py lms migrate learning_paths
+
+4. **Run Completion Aggregator Migrations**
+
+   Ensure that the **completion aggregator** service is also up to date by running its migrations:
+
+   .. code-block:: bash
+
+      ./manage.py lms migrate completion_aggregator
+
+   .. warning::
+
+      Please read the section about `synchronous vs asynchronous modes <https://github.com/open-craft/openedx-completion-aggregator/?tab=readme-ov-file#synchronous-vs-asynchronous-calculations>`_
+      for completion aggregator before enabling this in a production environment. Running in synchronous mode can lead to an outage.
+
+
+Once these steps are complete, the Learning Paths plugin should be successfully installed and ready to use.
+
+
+Usage
+*****
+After installing the plugin, a learning path can be created in the django admin panel `{LMS_URL}/admin/learning_paths/learningpath/`.
+
+
+Change Log
+##########
+
+..
+   All enhancements and patches to learning_paths will be documented
+   in this file.  It adheres to the structure of https://keepachangelog.com/ ,
+   but in reStructuredText instead of Markdown (for ease of incorporation into
+   Sphinx documentation and the PyPI description).
+
+   This project adheres to Semantic Versioning (https://semver.org/).
+
+.. There should always be an "Unreleased" section for changes pending release.
+
+Unreleased
+**********
+
+*
+
+0.2.3 - 2025-03-31
+******************
+
+Added
+=====
+
+* Enrollment API.
+
+0.2.2 - 2024-12-05
+******************
+
+Added
+=====
+
+* User grade API
+
+0.2.1 - 2024-10-28
+******************
+
+Added
+=====
+
+* Pathway progress API
+
+0.2.0 - 2024-01-23
+******************
+
+Added
+=====
+
+* Database models
+* Django Admin interface

learning_paths_plugin-0.2.3/README.rst

@@ -0,0 +1,65 @@
+learning-paths-plugin
+#####################
+
+Purpose
+*******
+
+A Learning Path consists of a selection of courses bundled together for
+learners to progress through. This plugin enables the creation and
+management of Learning Paths.
+
+License
+*******
+
+The code in this repository is licensed under the Not open source unless
+otherwise noted.
+
+Please see `LICENSE.txt <LICENSE.txt>`_ for details.
+
+Installation and Configuration
+******************************
+
+1. **Clone the Repository**
+
+   Clone the repository containing the plugin to the `src` directory under your devstack root:
+
+   .. code-block:: bash
+
+      git clone <repository_url> <devstack_root>/src/learning-paths-plugin
+
+2. **Install the Plugin**
+
+   Inside the LMS shell, install the plugin by running:
+
+   .. code-block:: bash
+
+      pip install -e /edx/src/learning-paths-plugin/
+
+3. **Run Migrations for the Plugin**
+
+   After installing the plugin, run the database migrations for `learning_paths`:
+
+   .. code-block:: bash
+
+      ./manage.py lms migrate learning_paths
+
+4. **Run Completion Aggregator Migrations**
+
+   Ensure that the **completion aggregator** service is also up to date by running its migrations:
+
+   .. code-block:: bash
+
+      ./manage.py lms migrate completion_aggregator
+
+   .. warning::
+
+      Please read the section about `synchronous vs asynchronous modes <https://github.com/open-craft/openedx-completion-aggregator/?tab=readme-ov-file#synchronous-vs-asynchronous-calculations>`_
+      for completion aggregator before enabling this in a production environment. Running in synchronous mode can lead to an outage.
+
+
+Once these steps are complete, the Learning Paths plugin should be successfully installed and ready to use.
+
+
+Usage
+*****
+After installing the plugin, a learning path can be created in the django admin panel `{LMS_URL}/admin/learning_paths/learningpath/`.

learning_paths_plugin-0.2.3/learning_paths/__init__.py

@@ -0,0 +1,5 @@
+"""
+Learning Paths plugin.
+"""
+
+__version__ = "0.2.3"

learning_paths_plugin-0.2.3/learning_paths/admin.py

@@ -0,0 +1,155 @@
+"""
+Django Admin for learning_paths.
+"""
+
+from django import forms
+from django.contrib import admin, auth
+from django.core.exceptions import ValidationError
+from django.db import transaction
+from django.utils.translation import gettext_lazy as _
+
+from .compat import get_course_keys_with_outlines
+from .models import (
+    AcquiredSkill,
+    LearningPath,
+    LearningPathEnrollment,
+    LearningPathGradingCriteria,
+    LearningPathStep,
+    RequiredSkill,
+    Skill,
+)
+
+User = auth.get_user_model()
+
+
+def get_course_keys_choices():
+    """Get course keys in an adequate format for a choice field."""
+    yield None, ""
+    for key in get_course_keys_with_outlines():
+        yield key, key
+
+
+class LearningPathStepForm(forms.ModelForm):
+    """Admin form for Learning Path step."""
+
+    # 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"))
+
+
+class LearningPathStepInline(admin.TabularInline):
+    """Inline Admin for Learning Path step."""
+
+    model = LearningPathStep
+    form = LearningPathStepForm
+
+
+class AcquiredSkillInline(admin.TabularInline):
+    """Inline Admin for Learning Path acquired skill."""
+
+    model = AcquiredSkill
+
+
+class RequiredSkillInline(admin.TabularInline):
+    """Inline Admin for Learning Path required skill."""
+
+    model = RequiredSkill
+
+
+class LearningPathGradingCriteriaInline(admin.TabularInline):
+    """Inline Admin for Learning path grading criteria."""
+
+    model = LearningPathGradingCriteria
+
+
+class BulkEnrollUsersForm(forms.ModelForm):
+    """Form to bulk enroll users in a learning path."""
+
+    usernames = forms.CharField(
+        widget=forms.Textarea,
+        help_text="Enter usernames separated by newlines",
+        label="Bulk enroll users",
+        required=False,
+    )
+
+    class Meta:
+        """Form options."""
+
+        model = LearningPath
+        fields = "__all__"
+
+    def clean_usernames(self):
+        """Validate usernames and return a list of users."""
+        data = self.cleaned_data["usernames"]
+        if not data:
+            return []
+        usernames = [username.strip() for username in data.split("\n")]
+        users = User.objects.filter(username__in=usernames)
+        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)}"
+            )
+        return users
+
+
+class LearningPathAdmin(admin.ModelAdmin):
+    """Admin for Learning Path."""
+
+    model = LearningPath
+    form = BulkEnrollUsersForm
+
+    search_fields = [
+        "slug",
+        "display_name",
+    ]
+    list_display = (
+        "uuid",
+        "slug",
+        "display_name",
+        "level",
+        "duration_in_days",
+    )
+
+    inlines = [
+        LearningPathStepInline,
+        RequiredSkillInline,
+        AcquiredSkillInline,
+        LearningPathGradingCriteriaInline,
+    ]
+
+    def save_related(self, request, form, formsets, change):
+        """Save related objects and enroll users in the learning path."""
+        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
+                )
+
+
+class SkillAdmin(admin.ModelAdmin):
+    """Admin for Learning Path generic skill."""
+
+    model = Skill
+
+
+class EnrolledUsersAdmin(admin.ModelAdmin):
+    """Admin for Learning Path enrollment."""
+
+    model = LearningPathEnrollment
+
+    search_fields = [
+        "id",
+        "user__username",
+        "learning_path__uuid",
+        "learning_path__slug",
+        "learning_path__display_name",
+    ]
+
+
+admin.site.register(LearningPath, LearningPathAdmin)
+admin.site.register(Skill, SkillAdmin)
+admin.site.register(LearningPathEnrollment, EnrolledUsersAdmin)

learning_paths_plugin-0.2.3/learning_paths/api/urls.py

@@ -0,0 +1,7 @@
+"""API URLs."""
+
+from django.urls import include, path
+
+urlpatterns = [
+    path("v1/", include("learning_paths.api.v1.urls")),
+]

learning_paths_plugin-0.2.3/learning_paths/api/v1/filters.py

@@ -0,0 +1,16 @@
+"""
+Django REST framework filters.
+"""
+
+from rest_framework.filters import BaseFilterBackend
+
+
+class AdminOrSelfFilterBackend(BaseFilterBackend):
+    """
+    A filter backend that limits the queryset to the current user for non-staff.
+    """
+
+    def filter_queryset(self, request, queryset, view):
+        if request.user.is_staff:
+            return queryset
+        return queryset.filter(user=request.user)

learning_paths_plugin-0.2.3/learning_paths/api/v1/permissions.py

@@ -0,0 +1,27 @@
+"""
+Django REST framework permissions.
+"""
+
+from rest_framework.permissions import BasePermission
+
+
+class IsAdminOrSelf(BasePermission):
+    """
+    Permission to allow only admins or the user themselves to access the API.
+
+    Non-staff users cannot pass "username" that is not their own.
+    """
+
+    def has_permission(self, request, view):
+        if request.user.is_staff:
+            return True
+
+        if request.method == "GET":
+            username = request.query_params.get("username")
+        else:
+            username = request.data.get("username")
+
+        # For learners, the username passed should match the logged in user
+        if username:
+            return request.user.username == username
+        return True

learning_paths_plugin-0.2.3/learning_paths/api/v1/serializers.py

@@ -0,0 +1,93 @@
+"""
+Serializer for LearningPath.
+"""
+
+from rest_framework import serializers
+
+from learning_paths.models import LearningPath, LearningPathEnrollment
+
+DEFAULT_STATUS = "active"
+IMAGE_WIDTH = 1440
+IMAGE_HEIGHT = 480
+
+
+class LearningPathAsProgramSerializer(serializers.ModelSerializer):
+    """
+    Serialize LearningPath as a Program to be ingested by course-discovery.
+
+    Mocked data example:
+    https://github.com/openedx/course-discovery/blob/d6a57fd69479b3d5f5afb682d2668b58503a6af6/course_discovery/apps/course_metadata/data_loaders/tests/mock_data.py#L580
+    """
+
+    name = serializers.CharField(source="display_name")
+    marketing_slug = serializers.SerializerMethodField()
+    title = serializers.CharField(source="display_name")
+    status = serializers.SerializerMethodField()
+    banner_image_urls = serializers.SerializerMethodField()
+    organizations = serializers.SerializerMethodField()
+    course_codes = serializers.SerializerMethodField()
+
+    def get_marketing_slug(self, obj):
+        return obj.slug
+
+    def get_status(self, obj):  # pylint: disable=unused-argument
+        return DEFAULT_STATUS
+
+    def get_banner_image_urls(self, obj):
+        if obj.image_url:
+            image_key = f"w{IMAGE_WIDTH}h{IMAGE_HEIGHT}"
+            return {image_key: obj.image_url}
+        return {}
+
+    def get_organizations(self, obj):  # pylint: disable=unused-argument
+        return []
+
+    def get_course_codes(self, obj):
+        """returns course_codes as expected by course-discovery"""
+        course_codes_dict = {}
+        learning_path_course_keys = [course.course_key for course in obj.steps.all()]
+        for course_key in learning_path_course_keys:
+            run_mode = {"course_key": str(course_key), "run_key": course_key.run}
+            if course_key.course in course_codes_dict:
+                course_codes_dict[course_key.course]["run_modes"].append(run_mode)
+            else:
+                course_codes_dict[course_key.course] = {"run_modes": [run_mode]}
+
+        return [{"key": key, **value} for key, value in course_codes_dict.items()]
+
+    class Meta:
+        model = LearningPath
+        fields = (
+            "uuid",
+            "name",
+            "marketing_slug",
+            "title",
+            "subtitle",
+            "status",
+            "banner_image_urls",
+            "organizations",
+            "course_codes",
+        )
+
+
+# pylint: disable=abstract-method
+class LearningPathProgressSerializer(serializers.Serializer):
+    learning_path_id = serializers.UUIDField()
+    progress = serializers.FloatField()
+    required_completion = serializers.FloatField()
+
+
+class LearningPathGradeSerializer(serializers.Serializer):
+    """
+    Serializer for learning path grade.
+    """
+
+    learning_path_id = serializers.UUIDField()
+    grade = serializers.FloatField()
+    required_grade = serializers.FloatField()
+
+
+class LearningPathEnrollmentSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = LearningPathEnrollment
+        fields = ("user", "learning_path", "is_active", "enrolled_at")

learning_paths_plugin-0.2.3/learning_paths/api/v1/urls.py

@@ -0,0 +1,46 @@
+"""API v1 URLs."""
+
+from django.urls import path
+from rest_framework import routers
+
+from learning_paths.api.v1.views import (
+    BulkEnrollView,
+    LearningPathAsProgramViewSet,
+    LearningPathEnrollmentView,
+    LearningPathUserGradeView,
+    LearningPathUserProgressView,
+    ListEnrollmentsView,
+)
+
+router = routers.SimpleRouter()
+router.register(
+    r"programs", LearningPathAsProgramViewSet, basename="learning-path-as-program"
+)
+
+urlpatterns = router.urls + [
+    path(
+        "<uuid:learning_path_uuid>/progress/",
+        LearningPathUserProgressView.as_view(),
+        name="learning-path-progress",
+    ),
+    path(
+        "<uuid:learning_path_uuid>/grade/",
+        LearningPathUserGradeView.as_view(),
+        name="learning-path-grade",
+    ),
+    path(
+        "<uuid:learning_path_id>/enrollments/",
+        LearningPathEnrollmentView.as_view(),
+        name="learning-path-enrollments",
+    ),
+    path(
+        "enrollments/",
+        ListEnrollmentsView.as_view(),
+        name="list-enrollments",
+    ),
+    path(
+        "enrollments/bulk-enroll/",
+        BulkEnrollView.as_view(),
+        name="bulk-enroll",
+    ),
+]