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

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

@@ -16,6 +16,14 @@ Unreleased
 
 *
 
+0.3.3 - 2025-05-23
+******************
+
+Changed
+=======
+
+* Changed line length from 80 to 120 characters.
+
 0.3.2 - 2025-05-02
 ******************
 

{learning_paths_plugin-0.3.2/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.2
+Version: 0.3.3
 Summary: Learning Paths plugin
 Home-page: https://github.com/open-craft/learning-paths-plugin
 Author: OpenCraft
@@ -121,6 +121,14 @@ Unreleased
 
 *
 
+0.3.3 - 2025-05-23
+******************
+
+Changed
+=======
+
+* Changed line length from 80 to 120 characters.
+
 0.3.2 - 2025-05-02
 ******************
 

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

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

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

@@ -65,9 +65,7 @@ class LearningPathStepForm(forms.ModelForm):
         """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
-        )
+        self.fields["course_key"].widget = CourseKeyDatalistWidget(choices=self._course_keys)
 
     course_key = forms.CharField(label=_("Course"))
 
@@ -77,9 +75,7 @@ class LearningPathStepForm(forms.ModelForm):
         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.")
-            )
+            raise ValidationError(_("Invalid course key. Please select a course from the suggestions."))
 
         return course_key
 
@@ -135,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
 
 
@@ -179,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):

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

@@ -104,9 +104,7 @@ 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)
@@ -168,12 +166,8 @@ class LearningPathDetailSerializer(LearningPathListSerializer):
     Serializer for learning path details.
     """
 
-    required_skills = RequiredSkillSerializer(
-        source="requiredskill_set", many=True, read_only=True
-    )
-    acquired_skills = AcquiredSkillSerializer(
-        source="acquiredskill_set", 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)
 
     class Meta(LearningPathListSerializer.Meta):
         fields = LearningPathListSerializer.Meta.fields + [

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

@@ -16,9 +16,7 @@ from learning_paths.api.v1.views import (
 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 + [

{learning_paths_plugin-0.3.2 → 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.2 → learning_paths_plugin-0.3.3}/learning_paths/api/v1/views.py

@@ -152,9 +152,7 @@ class LearningPathViewSet(viewsets.ReadOnlyModelViewSet):
         Get all learning paths and prefetch the related data.
         """
         user = self.request.user
-        queryset = LearningPath.objects.get_paths_visible_to_user(
-            user
-        ).prefetch_related(
+        queryset = LearningPath.objects.get_paths_visible_to_user(user).prefetch_related(
             "steps",
             "grading_criteria",
         )
@@ -203,9 +201,7 @@ class LearningPathEnrollmentView(APIView):
         """
         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"):
@@ -233,18 +229,14 @@ class LearningPathEnrollmentView(APIView):
         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)
@@ -276,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
@@ -360,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(
@@ -412,9 +399,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(is_enrolled=True),
             key=learning_path_key_str,
         )
 

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

@@ -72,7 +72,5 @@ def enroll_user_in_course(user: AbstractBaseUser, course_key: CourseKey) -> bool
         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
-        )
+        log.exception("Failed to enroll user %s in course %s: %s", user, course_key, exc)
         return False

{learning_paths_plugin-0.3.2 → learning_paths_plugin-0.3.3}/learning_paths/keys.py

@@ -12,15 +12,11 @@ from opaque_keys.edx.keys import LearningContextKey
 
 COURSE_KEY_NAMESPACE = "course-v1"
 COURSE_KEY_PATTERN = r"([^+]+)\+([^+]+)\+([^+]+)"
-COURSE_KEY_URL_PATTERN = (
-    rf"(?P<course_key_str>{COURSE_KEY_NAMESPACE}:{COURSE_KEY_PATTERN})"
-)
+COURSE_KEY_URL_PATTERN = rf"(?P<course_key_str>{COURSE_KEY_NAMESPACE}:{COURSE_KEY_PATTERN})"
 
 LEARNING_PATH_NAMESPACE = "path-v1"
 LEARNING_PATH_PATTERN = r"([^+]+)\+([^+]+)\+([^+]+)\+([^+]+)"
-LEARNING_PATH_URL_PATTERN = (
-    rf"(?P<learning_path_key_str>{LEARNING_PATH_NAMESPACE}:{LEARNING_PATH_PATTERN})"
-)
+LEARNING_PATH_URL_PATTERN = rf"(?P<learning_path_key_str>{LEARNING_PATH_NAMESPACE}:{LEARNING_PATH_PATTERN})"
 
 
 class LearningPathKey(LearningContextKey):
@@ -52,9 +48,7 @@ class LearningPathKey(LearningContextKey):
 
     def _to_string(self) -> str:
         """Return a string representing this key."""
-        return "+".join(
-            [self.org, self.number, self.run, self.group]  # pylint: disable=no-member
-        )
+        return "+".join([self.org, self.number, self.run, self.group])  # pylint: disable=no-member
 
 
 class LearningPathKeyField(LearningContextKeyField):

{learning_paths_plugin-0.3.2 → learning_paths_plugin-0.3.3}/learning_paths/models.py

@@ -114,16 +114,12 @@ class LearningPath(TimeStampedModel):
         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 (in days) it should take to complete this Learning Path."),
     )
     sequential = models.BooleanField(
         default=False,
         verbose_name=_("Is sequential"),
-        help_text=_(
-            "Whether the courses in this Learning Path are meant to be taken sequentially."
-        ),
+        help_text=_("Whether the courses in this Learning Path are meant to be taken sequentially."),
     )
     # Note: the enrolled learners will be able to self-enroll in all courses
     # (steps) of the learning path. To avoid mistakes of making the courses
@@ -132,9 +128,7 @@ class LearningPath(TimeStampedModel):
     invite_only = models.BooleanField(
         default=True,
         verbose_name=_("Invite only"),
-        help_text=_(
-            "If enabled, only staff can enroll users and only enrolled users can see the learning path."
-        ),
+        help_text=_("If enabled, only staff can enroll users and only enrolled users can see the learning path."),
     )
     enrolled_users = models.ManyToManyField(User, through="LearningPathEnrollment")
     tracker = FieldTracker(fields=["image"])
@@ -193,16 +187,12 @@ class LearningPathStep(TimeStampedModel):
         unique_together = ("learning_path", "course_key")
 
     course_key = CourseKeyField(max_length=255)
-    learning_path = models.ForeignKey(
-        LearningPath, related_name="steps", on_delete=models.CASCADE
-    )
+    learning_path = models.ForeignKey(LearningPath, related_name="steps", on_delete=models.CASCADE)
     order = models.PositiveIntegerField(
         blank=True,
         null=True,
         verbose_name=_("Sequential order"),
-        help_text=_(
-            "Ordinal position of this step in the sequence of the Learning Path, if applicable."
-        ),
+        help_text=_("Ordinal position of this step in the sequence of the Learning Path, if applicable."),
     )
     weight = models.FloatField(
         default=1.0,
@@ -259,9 +249,7 @@ 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(help_text=_("The skill level associated with this course."))
 
     def __str__(self):
         """User-friendly string representation of this model."""
@@ -305,8 +293,7 @@ class LearningPathEnrollment(TimeStampedModel):
     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."
+            "Timestamp of enrollment or un-enrollment. To be explicitly set when performing a learner enrollment."
         ),
     )
 
@@ -331,9 +318,7 @@ class LearningPathGradingCriteria(models.Model):
     .. no_pii:
     """
 
-    learning_path = models.OneToOneField(
-        LearningPath, related_name="grading_criteria", on_delete=models.CASCADE
-    )
+    learning_path = models.OneToOneField(LearningPath, related_name="grading_criteria", on_delete=models.CASCADE)
     required_completion = models.FloatField(
         default=0.80,
         help_text=(

{learning_paths_plugin-0.3.2 → learning_paths_plugin-0.3.3}/learning_paths/receivers.py

@@ -7,9 +7,7 @@ from learning_paths.models import LearningPathEnrollment, LearningPathEnrollment
 logger = logging.getLogger(__name__)
 
 
-def process_pending_enrollments(
-    sender, instance, created, **kwargs
-):  # pylint: disable=unused-argument
+def process_pending_enrollments(sender, instance, created, **kwargs):  # pylint: disable=unused-argument
     """
     Process pending enrollments after a user instance has been created.
 
@@ -31,9 +29,7 @@ def process_pending_enrollments(
         return
 
     logger.info("[LearningPaths] Processing pending enrollments for user %s", instance)
-    pending_enrollments = LearningPathEnrollmentAllowed.objects.filter(
-        email=instance.email
-    ).all()
+    pending_enrollments = LearningPathEnrollmentAllowed.objects.filter(email=instance.email).all()
 
     enrollments = []
 
@@ -41,9 +37,7 @@ def process_pending_enrollments(
         entry.user = instance
         entry.save()
 
-        enrollments.append(
-            LearningPathEnrollment(learning_path=entry.learning_path, user=instance)
-        )
+        enrollments.append(LearningPathEnrollment(learning_path=entry.learning_path, user=instance))
     new_enrollments = LearningPathEnrollment.objects.bulk_create(enrollments)
     logger.info(
         "[LearningPaths] Processed %d pending Learning Path enrollments for user %s.",

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-paths-plugin
-Version: 0.3.2
+Version: 0.3.3
 Summary: Learning Paths plugin
 Home-page: https://github.com/open-craft/learning-paths-plugin
 Author: OpenCraft
@@ -121,6 +121,14 @@ Unreleased
 
 *
 
+0.3.3 - 2025-05-23
+******************
+
+Changed
+=======
+
+* Changed line length from 80 to 120 characters.
+
 0.3.2 - 2025-05-02
 ******************
 

learning_paths_plugin-0.3.3/pyproject.toml

@@ -0,0 +1,16 @@
+[tool.black]
+line-length = 120
+exclude = '''
+/(
+    \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+  | migrations
+)/
+'''

{learning_paths_plugin-0.3.2 → learning_paths_plugin-0.3.3}/setup.py

@@ -62,13 +62,10 @@ def load_requirements(*requirements_paths):
     re_package_name_base_chars = r"a-zA-Z0-9\-_."  # chars allowed in base package name
     # Two groups: name[maybe,extras], and optionally a constraint
     requirement_line_regex = re.compile(
-        r"([%s]+(?:\[[%s,\s]+\])?)([<>=][^#\s]+)?"
-        % (re_package_name_base_chars, re_package_name_base_chars)
+        r"([%s]+(?:\[[%s,\s]+\])?)([<>=][^#\s]+)?" % (re_package_name_base_chars, re_package_name_base_chars)
     )
 
-    def add_version_constraint_or_raise(
-        current_line, current_requirements, add_if_not_present
-    ):
+    def add_version_constraint_or_raise(current_line, current_requirements, add_if_not_present):
         regex_match = requirement_line_regex.match(current_line)
         if regex_match:
             package = regex_match.group(1)
@@ -77,10 +74,7 @@ def load_requirements(*requirements_paths):
             existing_version_constraints = current_requirements.get(package, None)
             # It's fine to add constraints to an unconstrained package,
             # but raise an error if there are already constraints in place.
-            if (
-                existing_version_constraints
-                and existing_version_constraints != version_constraints
-            ):
+            if existing_version_constraints and existing_version_constraints != version_constraints:
                 raise BaseException(
                     f"Multiple constraint definitions found for {package}:"
                     f' "{existing_version_constraints}" and "{version_constraints}".'
@@ -98,11 +92,7 @@ def load_requirements(*requirements_paths):
                 if is_requirement(line):
                     add_version_constraint_or_raise(line, requirements, True)
                 if line and line.startswith("-c") and not line.startswith("-c http"):
-                    constraint_files.add(
-                        os.path.dirname(path)
-                        + "/"
-                        + line.split("#")[0].replace("-c", "").strip()
-                    )
+                    constraint_files.add(os.path.dirname(path) + "/" + line.split("#")[0].replace("-c", "").strip())
 
     # process constraint files: add constraints to existing requirements
     for constraint_file in constraint_files:
@@ -112,9 +102,7 @@ def load_requirements(*requirements_paths):
                     add_version_constraint_or_raise(line, requirements, False)
 
     # process back into list of pkg><=constraints strings
-    constrained_requirements = [
-        f'{pkg}{version or ""}' for (pkg, version) in sorted(requirements.items())
-    ]
+    constrained_requirements = [f'{pkg}{version or ""}' for (pkg, version) in sorted(requirements.items())]
     return constrained_requirements
 
 
@@ -126,9 +114,7 @@ def is_requirement(line):
         bool: True if the line is not blank, a comment,
         a URL, or an included file
     """
-    return (
-        line and line.strip() and not line.startswith(("-r", "#", "-e", "git+", "-c"))
-    )
+    return line and line.strip() and not line.startswith(("-r", "#", "-e", "git+", "-c"))
 
 
 VERSION = get_version("learning_paths", "__init__.py")
@@ -139,12 +125,8 @@ if sys.argv[-1] == "tag":
     os.system("git push --tags")
     sys.exit()
 
-README = open(
-    os.path.join(os.path.dirname(__file__), "README.rst"), encoding="utf8"
-).read()
-CHANGELOG = open(
-    os.path.join(os.path.dirname(__file__), "CHANGELOG.rst"), encoding="utf8"
-).read()
+README = open(os.path.join(os.path.dirname(__file__), "README.rst"), encoding="utf8").read()
+CHANGELOG = open(os.path.join(os.path.dirname(__file__), "CHANGELOG.rst"), encoding="utf8").read()
 
 setup(
     name="learning-paths-plugin",

learning_paths_plugin-0.3.2/pyproject.toml

@@ -1,9 +0,0 @@
-[tool.black]
-exclude = '''
-/(
-    \.git
-  | \.tox
-  | _build
-  | migrations
-)/
-'''