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

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

@@ -16,6 +16,24 @@ Unreleased
 
 *
 
+0.3.1 - 2025-04-14
+******************
+
+Added
+=====
+
+* API for listing and retrieving Learning Paths.
+
+Fixed
+=====
+
+* Automatically create grading criteria for Learning Paths.
+
+Changed
+=======
+
+* Replaced relative due dates with actual due dates from course runs.
+
 0.3.0 - 2025-04-03
 ******************
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-paths-plugin
-Version: 0.3.0
+Version: 0.3.1
 Summary: Learning Paths plugin
 Home-page: https://github.com/open-craft/learning-paths-plugin
 Author: OpenCraft
@@ -120,6 +120,24 @@ Unreleased
 
 *
 
+0.3.1 - 2025-04-14
+******************
+
+Added
+=====
+
+* API for listing and retrieving Learning Paths.
+
+Fixed
+=====
+
+* Automatically create grading criteria for Learning Paths.
+
+Changed
+=======
+
+* Replaced relative due dates with actual due dates from course runs.
+
 0.3.0 - 2025-04-03
 ******************
 

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

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

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

@@ -4,7 +4,14 @@ Serializer for LearningPath.
 
 from rest_framework import serializers
 
-from learning_paths.models import LearningPath, LearningPathEnrollment
+from learning_paths.models import (
+    AcquiredSkill,
+    LearningPath,
+    LearningPathEnrollment,
+    LearningPathStep,
+    RequiredSkill,
+    Skill,
+)
 
 DEFAULT_STATUS = "active"
 IMAGE_WIDTH = 1440
@@ -87,6 +94,98 @@ class LearningPathGradeSerializer(serializers.Serializer):
     required_grade = serializers.FloatField()
 
 
+class LearningPathStepSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = LearningPathStep
+        fields = ["order", "course_key", "due_date", "weight"]
+
+
+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
+    )
+
+    class Meta:
+        model = LearningPath
+        fields = [
+            "key",
+            "slug",
+            "display_name",
+            "image_url",
+            "sequential",
+            "steps",
+            "required_completion",
+        ]
+
+
+class SkillSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Skill
+        fields = ["id", "display_name"]
+
+
+class RequiredSkillSerializer(serializers.ModelSerializer):
+    """
+    Serializer for required skill.
+    """
+
+    skill = SkillSerializer()
+
+    class Meta:
+        model = RequiredSkill
+        fields = ["skill", "level"]
+
+
+class AcquiredSkillSerializer(serializers.ModelSerializer):
+    """
+    Serializer for acquired skill.
+    """
+
+    skill = SkillSerializer()
+
+    class Meta:
+        model = AcquiredSkill
+        fields = ["skill", "level"]
+
+
+class LearningPathDetailSerializer(serializers.ModelSerializer):
+    """
+    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
+    )
+
+    class Meta:
+        model = LearningPath
+        fields = [
+            "key",
+            "slug",
+            "display_name",
+            "subtitle",
+            "description",
+            "image_url",
+            "level",
+            "duration_in_days",
+            "sequential",
+            "steps",
+            "required_skills",
+            "acquired_skills",
+            "required_completion",
+        ]
+
+
 class LearningPathEnrollmentSerializer(serializers.ModelSerializer):
     class Meta:
         model = LearningPathEnrollment

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

@@ -9,6 +9,7 @@ from learning_paths.api.v1.views import (
     LearningPathEnrollmentView,
     LearningPathUserGradeView,
     LearningPathUserProgressView,
+    LearningPathViewSet,
     ListEnrollmentsView,
 )
 from learning_paths.keys import LEARNING_PATH_URL_PATTERN
@@ -17,6 +18,7 @@ router = routers.SimpleRouter()
 router.register(
     r"programs", LearningPathAsProgramViewSet, basename="learning-path-as-program"
 )
+router.register(r"learning-paths", LearningPathViewSet, basename="learning-path")
 
 urlpatterns = router.urls + [
     re_path(

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

@@ -12,6 +12,7 @@ from django.core.validators import validate_email
 from django.shortcuts import get_object_or_404
 from opaque_keys import InvalidKeyError
 from rest_framework import generics, status, viewsets
+from rest_framework.exceptions import NotFound
 from rest_framework.pagination import PageNumberPagination
 from rest_framework.permissions import IsAdminUser, IsAuthenticated
 from rest_framework.response import Response
@@ -19,8 +20,10 @@ from rest_framework.views import APIView
 
 from learning_paths.api.v1.serializers import (
     LearningPathAsProgramSerializer,
+    LearningPathDetailSerializer,
     LearningPathEnrollmentSerializer,
     LearningPathGradeSerializer,
+    LearningPathListSerializer,
     LearningPathProgressSerializer,
 )
 from learning_paths.keys import LearningPathKey
@@ -125,6 +128,30 @@ class LearningPathUserGradeView(APIView):
         return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
 
 
+class LearningPathViewSet(viewsets.ReadOnlyModelViewSet):
+    """
+    ViewSet for listing all learning paths and retrieving a specific learning path's details,
+    including steps and associated skills.
+    """
+
+    queryset = LearningPath.objects.prefetch_related("steps", "grading_criteria")
+    permission_classes = (IsAuthenticated,)
+    pagination_class = PageNumberPagination
+    lookup_field = "key"
+
+    def get_serializer_class(self):
+        if self.action == "list":
+            return LearningPathListSerializer
+        return LearningPathDetailSerializer
+
+    def get_object(self):
+        """Gracefully handle an invalid learning path key format."""
+        try:
+            return super().get_object()
+        except InvalidKeyError as exc:
+            raise NotFound("Invalid learning path key format.") from exc
+
+
 class LearningPathEnrollmentView(APIView):
     """
     API View to handle changes to LearningPathEnrollment model

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

@@ -2,6 +2,8 @@
 Compatibility layer for testing without Open edX.
 """
 
+from datetime import datetime
+
 from django.contrib.auth.models import AbstractBaseUser
 from opaque_keys.edx.keys import CourseKey
 
@@ -41,8 +43,23 @@ def get_course_keys_with_outlines():
     return course_keys_with_outlines()
 
 
+def get_course_due_date(course_key: CourseKey) -> datetime | None:
+    """
+    Retrieve course end date.
+    """
+    # pylint: disable=import-outside-toplevel, import-error
+    from openedx.core.djangoapps.content.course_overviews.models import CourseOverview
+
+    try:
+        overview = CourseOverview.objects.get(id=course_key)
+        return overview.end
+    except CourseOverview.DoesNotExist:
+        return None
+
+
 __all__ = [
     "get_course_keys_with_outlines",
     "get_catalog_api_client",
     "get_user_course_grade",
+    "get_course_due_date",
 ]

learning_paths_plugin-0.3.1/learning_paths/migrations/0008_remove_learningpathstep_relative_due_date_in_days.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.2.16 on 2025-03-24 10:37
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('learning_paths', '0007_replace_uuid_with_learningpathkey'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='learningpathstep',
+            name='relative_due_date_in_days',
+        ),
+    ]

{learning_paths_plugin-0.3.0 → learning_paths_plugin-0.3.1}/learning_paths/models.py

@@ -2,7 +2,7 @@
 Database models for learning_paths.
 """
 
-from datetime import timedelta
+from datetime import datetime, timedelta
 from uuid import uuid4
 
 from django.contrib import auth
@@ -13,7 +13,7 @@ from model_utils.models import TimeStampedModel
 from opaque_keys.edx.django.models import CourseKeyField
 from simple_history.models import HistoricalRecords
 
-from .compat import get_user_course_grade
+from .compat import get_course_due_date, get_user_course_grade
 from .keys import LearningPathKeyField
 
 User = auth.get_user_model()
@@ -88,6 +88,14 @@ class LearningPath(TimeStampedModel):
         """User-friendly string representation of this model."""
         return self.display_name
 
+    def save(self, *args, **kwargs):
+        """Create default grading criteria when a new learning path is created."""
+        is_new = self._state.adding
+        super().save(*args, **kwargs)
+
+        if is_new and not hasattr(self, "grading_criteria"):
+            LearningPathGradingCriteria.objects.get_or_create(learning_path=self)
+
 
 class LearningPathStep(TimeStampedModel):
     """
@@ -105,14 +113,6 @@ class LearningPathStep(TimeStampedModel):
     learning_path = models.ForeignKey(
         LearningPath, related_name="steps", on_delete=models.CASCADE
     )
-    relative_due_date_in_days = models.PositiveIntegerField(
-        blank=True,
-        null=True,
-        verbose_name=_("Due date (days)"),
-        help_text=_(
-            "Used to calculate the due date from the starting date of the course."
-        ),
-    )
     order = models.PositiveIntegerField(
         blank=True,
         null=True,
@@ -130,6 +130,11 @@ class LearningPathStep(TimeStampedModel):
         ),
     )
 
+    @property
+    def due_date(self) -> datetime | None:
+        """Retrieve the due date for this course."""
+        return get_course_due_date(self.course_key)
+
     def __str__(self):
         """User-friendly string representation of this model."""
         return "{}: {}".format(self.order, self.course_key)

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-paths-plugin
-Version: 0.3.0
+Version: 0.3.1
 Summary: Learning Paths plugin
 Home-page: https://github.com/open-craft/learning-paths-plugin
 Author: OpenCraft
@@ -120,6 +120,24 @@ Unreleased
 
 *
 
+0.3.1 - 2025-04-14
+******************
+
+Added
+=====
+
+* API for listing and retrieving Learning Paths.
+
+Fixed
+=====
+
+* Automatically create grading criteria for Learning Paths.
+
+Changed
+=======
+
+* Replaced relative due dates with actual due dates from course runs.
+
 0.3.0 - 2025-04-03
 ******************
 

{learning_paths_plugin-0.3.0 → learning_paths_plugin-0.3.1}/learning_paths_plugin.egg-info/SOURCES.txt

@@ -30,6 +30,7 @@ learning_paths/migrations/0004_auto_20240207_1633.py
 learning_paths/migrations/0005_learningpathstep_weight_learningpathgradingcriteria.py
 learning_paths/migrations/0006_enrollment_models.py
 learning_paths/migrations/0007_replace_uuid_with_learningpathkey.py
+learning_paths/migrations/0008_remove_learningpathstep_relative_due_date_in_days.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.0 → learning_paths_plugin-0.3.1}/tests/test_models.py

@@ -77,3 +77,11 @@ class TestLearningPath:
                 key=LearningPathKey("org2", "number2", "run2", "group2"),
                 slug=learning_path.slug,
             )
+
+    def test_grading_criteria_auto_creation(self, learning_path):
+        """Test that grading criteria is automatically created with a learning path."""
+
+        criteria = learning_path.grading_criteria
+        assert criteria is not None
+        assert criteria.required_completion == 0.80
+        assert criteria.required_grade == 0.75