learning-credentials 0.2.0rc2__tar.gz → 0.2.1__tar.gz

{learning_credentials-0.2.0rc2 → learning_credentials-0.2.1}/CHANGELOG.rst

@@ -16,13 +16,21 @@ Unreleased
 
 *
 
-0.2.0 – 2025-03-31
+0.2.1 – 2025-05-05
+******************
+
+Fixed
+=====
+
+* Check enrollment status before issuing Learning Path credentials.
+
+0.2.0 – 2025-04-03
 ******************
 
 Added
 =====
 
-* Initial implementation of the certificates app.
+* Learning Paths support.
 
 
 0.1.0 – 2025-01-29

{learning_credentials-0.2.0rc2 → learning_credentials-0.2.1}/MANIFEST.in

@@ -3,4 +3,4 @@ include LICENSE.txt
 include README.rst
 include requirements/base.in
 include requirements/constraints.txt
-recursive-include learning_credentials *.html *.png *.gif *.js *.css *.jpg *.jpeg *.svg
+recursive-include learning_credentials *.html *.png *.gif *.js *.css *.jpg *.jpeg *.svg *.txt

{learning_credentials-0.2.0rc2/learning_credentials.egg-info → learning_credentials-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-credentials
-Version: 0.2.0rc2
+Version: 0.2.1
 Summary: A pluggable service for preparing Open edX credentials.
 Home-page: https://github.com/open-craft/learning-credentials
 Author: OpenCraft
@@ -28,7 +28,7 @@ Requires-Dist: django_reverse_admin
 Requires-Dist: djangorestframework
 Requires-Dist: edx-opaque-keys
 Requires-Dist: edx_ace
-Requires-Dist: learning-paths-plugin==0.3.0rc1
+Requires-Dist: learning-paths-plugin>=0.3.0
 Requires-Dist: openedx-completion-aggregator
 Requires-Dist: pypdf
 Requires-Dist: reportlab
@@ -139,7 +139,7 @@ Please do not report security issues in public. Please email security@openedx.or
     :target: https://pypi.python.org/pypi/learning-credentials/
     :alt: PyPI
 
-.. |ci-badge| image:: https://github.com/open-craft/learning-credentials/workflows/Python%20CI/badge.svg?branch=main
+.. |ci-badge| image:: https://github.com/open-craft/learning-credentials/actions/workflows/ci.yml/badge.svg?branch=main
     :target: https://github.com/open-craft/learning-credentials/actions
     :alt: CI
 
@@ -159,7 +159,7 @@ Please do not report security issues in public. Please email security@openedx.or
     :target: https://github.com/open-craft/learning-credentials/blob/main/LICENSE.txt
     :alt: License
 
-.. |status-badge| image:: https://img.shields.io/badge/Status-Experimental-yellow
+.. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen
     :alt: Status
 
 .. https://githubnext.com/projects/repo-visualization/
@@ -186,13 +186,21 @@ Unreleased
 
 *
 
-0.2.0 – 2025-03-31
+0.2.1 – 2025-05-05
+******************
+
+Fixed
+=====
+
+* Check enrollment status before issuing Learning Path credentials.
+
+0.2.0 – 2025-04-03
 ******************
 
 Added
 =====
 
-* Initial implementation of the certificates app.
+* Learning Paths support.
 
 
 0.1.0 – 2025-01-29

{learning_credentials-0.2.0rc2 → learning_credentials-0.2.1}/README.rst

@@ -92,7 +92,7 @@ Please do not report security issues in public. Please email security@openedx.or
     :target: https://pypi.python.org/pypi/learning-credentials/
     :alt: PyPI
 
-.. |ci-badge| image:: https://github.com/open-craft/learning-credentials/workflows/Python%20CI/badge.svg?branch=main
+.. |ci-badge| image:: https://github.com/open-craft/learning-credentials/actions/workflows/ci.yml/badge.svg?branch=main
     :target: https://github.com/open-craft/learning-credentials/actions
     :alt: CI
 
@@ -112,7 +112,7 @@ Please do not report security issues in public. Please email security@openedx.or
     :target: https://github.com/open-craft/learning-credentials/blob/main/LICENSE.txt
     :alt: License
 
-.. |status-badge| image:: https://img.shields.io/badge/Status-Experimental-yellow
+.. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen
     :alt: Status
 
 .. https://githubnext.com/projects/repo-visualization/

{learning_credentials-0.2.0rc2 → learning_credentials-0.2.1}/learning_credentials/__init__.py

@@ -1,3 +1,3 @@
 """A pluggable service for preparing Open edX credentials."""
 
-__version__ = '0.2.0rc2'
+__version__ = '0.2.1'

{learning_credentials-0.2.0rc2 → learning_credentials-0.2.1}/learning_credentials/generators.py

@@ -98,7 +98,7 @@ def _write_text_on_template(template: any, font: str, username: str, context_nam
     pdf_canvas.drawString(name_x, name_y, username)
 
     # Write the learning context name.
-    pdf_canvas.setFont(font, 28)
+    pdf_canvas.setFont(font, options.get('context_name_size', 28))
     context_name_color = options.get('context_name_color', '#000')
     pdf_canvas.setFillColorRGB(*hex_to_rgb(context_name_color))
 
@@ -187,6 +187,7 @@ def generate_pdf_credential(
       - context_name: Specify the custom course or Learning Path name.
       - context_name_y: The Y coordinate of the context name on the credential (vertical position on the template).
       - context_name_color: The color of the context name on the credential (hexadecimal color code).
+      - context_name_size: The font size of the context name on the credential. The default value is 28.
       - issue_date_y: The Y coordinate of the issue date on the credential (vertical position on the template).
       - issue_date_color: The color of the issue date on the credential (hexadecimal color code).
     """

{learning_credentials-0.2.0rc2 → learning_credentials-0.2.1}/learning_credentials/models.py

@@ -291,7 +291,7 @@ class Credential(TimeStampedModel):
 
     def send_email(self):
         """Send a credential link to the student."""
-        course_name = get_learning_context_name(self.learning_context_key)
+        learning_context_name = get_learning_context_name(self.learning_context_key)
         user = get_user_model().objects.get(id=self.user_id)
         msg = Message(
             name="certificate_generated",
@@ -299,8 +299,8 @@ class Credential(TimeStampedModel):
             recipient=Recipient(lms_user_id=user.id, email_address=user.email),
             language='en',
             context={
-                'credential_link': self.download_url,
-                'course_name': course_name,
+                'certificate_link': self.download_url,
+                'course_name': learning_context_name,
                 'platform_name': settings.PLATFORM_NAME,
             },
         )

{learning_credentials-0.2.0rc2 → learning_credentials-0.2.1}/learning_credentials/processors.py

@@ -68,6 +68,11 @@ def _process_learning_context(
         else:
             results &= course_results
 
+    # Filter out users who are not enrolled in the Learning Path.
+    results &= set(
+        learning_path.enrolled_users.filter(learningpathenrollment__is_active=True).values_list('id', flat=True),
+    )
+
     return list(results) if results else []
 
 
@@ -240,6 +245,7 @@ def _retrieve_course_completions(course_id: CourseKey, options: dict[str, Any])
     required_completion = options.get('required_completion', 0.9)
 
     url = f'/completion-aggregator/v1/course/{course_id}/'
+    # The API supports up to 10k results per page, but we limit it to 1k to avoid performance issues.
     query_params = {'page_size': 1000, 'page': 1}
 
     # TODO: Extract the logic of this view into an API. The current approach is very hacky.

learning_credentials-0.2.1/learning_credentials/templates/learning_credentials/edx_ace/certificate_generated/email/body.txt

@@ -0,0 +1,13 @@
+{% load i18n %}{% autoescape off %}
+
+{% blocktrans %}Thank you for your participation in {{ course_name }} at {{ platform_name }}!{% endblocktrans %}
+
+{% blocktrans %}We are happy to inform you that you have earned a certificate. You should feel very proud of the work you have done in this course. We congratulate you on your efforts and your learning.{% endblocktrans %}
+
+{% trans "To view and download your certificate, please click on the following link:" %}
+
+{{ certificate_link }}
+
+{% blocktrans %}Thank you for choosing {{ platform_name }} for your learning journey. We look forward to seeing you in more courses in the future.{% endblocktrans %}
+
+{% endautoescape %}

learning_credentials-0.2.1/learning_credentials/templates/learning_credentials/edx_ace/certificate_generated/email/from_name.txt

@@ -0,0 +1 @@
+{{ platform_name }}

learning_credentials-0.2.1/learning_credentials/templates/learning_credentials/edx_ace/certificate_generated/email/subject.txt

@@ -0,0 +1,4 @@
+{% load i18n %}
+{% autoescape off %}
+{% blocktrans trimmed %}{{ course_name }} - Certificate{% endblocktrans %}
+{% endautoescape %}

{learning_credentials-0.2.0rc2 → learning_credentials-0.2.1/learning_credentials.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-credentials
-Version: 0.2.0rc2
+Version: 0.2.1
 Summary: A pluggable service for preparing Open edX credentials.
 Home-page: https://github.com/open-craft/learning-credentials
 Author: OpenCraft
@@ -28,7 +28,7 @@ Requires-Dist: django_reverse_admin
 Requires-Dist: djangorestframework
 Requires-Dist: edx-opaque-keys
 Requires-Dist: edx_ace
-Requires-Dist: learning-paths-plugin==0.3.0rc1
+Requires-Dist: learning-paths-plugin>=0.3.0
 Requires-Dist: openedx-completion-aggregator
 Requires-Dist: pypdf
 Requires-Dist: reportlab
@@ -139,7 +139,7 @@ Please do not report security issues in public. Please email security@openedx.or
     :target: https://pypi.python.org/pypi/learning-credentials/
     :alt: PyPI
 
-.. |ci-badge| image:: https://github.com/open-craft/learning-credentials/workflows/Python%20CI/badge.svg?branch=main
+.. |ci-badge| image:: https://github.com/open-craft/learning-credentials/actions/workflows/ci.yml/badge.svg?branch=main
     :target: https://github.com/open-craft/learning-credentials/actions
     :alt: CI
 
@@ -159,7 +159,7 @@ Please do not report security issues in public. Please email security@openedx.or
     :target: https://github.com/open-craft/learning-credentials/blob/main/LICENSE.txt
     :alt: License
 
-.. |status-badge| image:: https://img.shields.io/badge/Status-Experimental-yellow
+.. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen
     :alt: Status
 
 .. https://githubnext.com/projects/repo-visualization/
@@ -186,13 +186,21 @@ Unreleased
 
 *
 
-0.2.0 – 2025-03-31
+0.2.1 – 2025-05-05
+******************
+
+Fixed
+=====
+
+* Check enrollment status before issuing Learning Path credentials.
+
+0.2.0 – 2025-04-03
 ******************
 
 Added
 =====
 
-* Initial implementation of the certificates app.
+* Learning Paths support.
 
 
 0.1.0 – 2025-01-29

{learning_credentials-0.2.0rc2 → learning_credentials-0.2.1}/learning_credentials.egg-info/SOURCES.txt

@@ -33,7 +33,10 @@ learning_credentials/settings/common.py
 learning_credentials/settings/production.py
 learning_credentials/templates/learning_credentials/base.html
 learning_credentials/templates/learning_credentials/edx_ace/certificate_generated/email/body.html
+learning_credentials/templates/learning_credentials/edx_ace/certificate_generated/email/body.txt
+learning_credentials/templates/learning_credentials/edx_ace/certificate_generated/email/from_name.txt
 learning_credentials/templates/learning_credentials/edx_ace/certificate_generated/email/head.html
+learning_credentials/templates/learning_credentials/edx_ace/certificate_generated/email/subject.txt
 openedx_certificates/__init__.py
 openedx_certificates/apps.py
 openedx_certificates/models.py

{learning_credentials-0.2.0rc2 → learning_credentials-0.2.1}/learning_credentials.egg-info/requires.txt

@@ -7,7 +7,7 @@ django_reverse_admin
 djangorestframework
 edx-opaque-keys
 edx_ace
-learning-paths-plugin==0.3.0rc1
+learning-paths-plugin>=0.3.0
 openedx-completion-aggregator
 pypdf
 reportlab

{learning_credentials-0.2.0rc2 → learning_credentials-0.2.1}/requirements/base.in

@@ -14,5 +14,4 @@ pypdf                   # PDF manipulation library
 reportlab               # PDF generation library
 openedx-completion-aggregator # Completion aggregation service
 edx_ace                 # Messaging library
-# TODO: Use the PyPI version of this package once it is available. Ensure to pin the minimum version.
-learning-paths-plugin==0.3.0rc1
+learning-paths-plugin>=0.3.0

{learning_credentials-0.2.0rc2 → learning_credentials-0.2.1}/tests/test_generators.py

@@ -75,6 +75,7 @@ def test_register_font_with_custom_font(mock_register_font: Mock, mock_font_clas
                 'name_color': '123',
                 'context_name_color': '#9B192A',
                 'issue_date_color': '#f59a8e',
+                'context_name_size': 20,
             },
             {
                 'name_color': (17 / 255, 34 / 255, 51 / 255),
@@ -135,7 +136,7 @@ def test_write_text_on_template(mock_canvas_class: Mock, context_name: str, opti
     assert canvas_object.drawString.call_args_list[0] == call(expected_name_x, expected_name_y, username)
     assert mock_canvas_class.return_value.stringWidth.mock_calls[0][1] == (username,)
 
-    assert canvas_object.setFont.call_args_list[1] == call(font, 28)
+    assert canvas_object.setFont.call_args_list[1] == call(font, options.get('context_name_size', 28))
     assert canvas_object.setFillColorRGB.call_args_list[1] == call(*expected_context_name_color)
 
     assert canvas_object.setFont.call_args_list[2] == call(font, 12)

{learning_credentials-0.2.0rc2 → learning_credentials-0.2.1}/tests/test_processors.py

@@ -2,11 +2,12 @@
 
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
 from unittest.mock import Mock, call, patch
 
 import pytest
 from django.http import QueryDict
-from learning_paths.models import LearningPath, LearningPathStep
+from learning_paths.models import LearningPath
 from opaque_keys.edx.keys import CourseKey
 
 # noinspection PyProtectedMember
@@ -19,6 +20,10 @@ from learning_credentials.processors import (
     retrieve_completions_and_grades,
     retrieve_subsection_grades,
 )
+from test_utils.factories import UserFactory
+
+if TYPE_CHECKING:
+    from django.contrib.auth.models import User
 
 
 @patch(
@@ -322,66 +327,59 @@ def test_retrieve_course_completions_and_grades(
 
 
 @pytest.fixture
-def learning_path_with_courses() -> LearningPath:
-    """Create a LearningPath with multiple course steps."""
-    learning_path = LearningPath.objects.create(
-        key='path-v1:test+number+run+group',
-        slug="test",
-    )
+def users() -> list[User]:
+    """Create a list of users."""
+    return UserFactory.create_batch(6)
 
-    course_keys = [f"course-v1:TestX+Test101+2023_{i}" for i in range(3)]
 
-    for i, course_key_str in enumerate(course_keys):
-        LearningPathStep.objects.create(learning_path=learning_path, course_key=course_key_str, order=i)
+@pytest.fixture
+def learning_path_with_courses(users: list[User]) -> LearningPath:
+    """Create a LearningPath with multiple course steps."""
+    learning_path = LearningPath.objects.create(key='path-v1:test+number+run+group')
 
-    return learning_path
+    for i in range(3):
+        learning_path.steps.create(course_key=f"course-v1:TestX+Test101+2023_{i}", order=i)
 
+    # Enroll all users except the last one.
+    for i in range(len(users) - 1):
+        learning_path.enrolled_users.add(users[i])
 
-@pytest.mark.django_db
-@patch("learning_credentials.processors._retrieve_course_subsection_grades")
-def test_retrieve_subsection_grades_with_learning_path(
-    mock_retrieve_course_subsection_grades: Mock,
-    learning_path_with_courses: LearningPath,
-):
-    """Test retrieving subsection grades with a real learning path."""
-    options = Mock()
-    mock_retrieve_course_subsection_grades.side_effect = [
-        [101, 102, 103],  # Users passing course0
-        [102, 103, 104],  # Users passing course1
-        [101, 103, 105],  # Users passing course2
-    ]
+    # Mark the second last user's enrollment as inactive.
+    learning_path.learningpathenrollment_set.filter(user=users[-2]).update(is_active=False)
 
-    result = retrieve_subsection_grades(learning_path_with_courses.key, options)
-
-    assert result == [103]
-
-    assert mock_retrieve_course_subsection_grades.call_count == 3
-    course_keys = [step.course_key for step in learning_path_with_courses.steps.all()]
-    for i, course_key in enumerate(course_keys):
-        call_args = mock_retrieve_course_subsection_grades.call_args_list[i]
-        assert call_args[0] == (course_key, options)
+    return learning_path
 
 
+@pytest.mark.parametrize(
+    ('patch_target', 'function_to_test'),
+    [
+        ("learning_credentials.processors._retrieve_course_subsection_grades", retrieve_subsection_grades),
+        ("learning_credentials.processors._retrieve_course_completions", retrieve_completions),
+    ],
+    ids=['subsection_grades', 'completions'],
+)
 @pytest.mark.django_db
-@patch("learning_credentials.processors._retrieve_course_completions")
-def test_retrieve_completions_with_learning_path_db(
-    mock_retrieve_course_completions: Mock,
+def test_retrieve_data_for_learning_path(
+    patch_target: str,
+    function_to_test: callable,
     learning_path_with_courses: LearningPath,
+    users: list[User],
 ):
-    """Test retrieving completions with a real learning path."""
-    options = Mock()
-    mock_retrieve_course_completions.side_effect = [
-        [101, 102, 103, 106],  # Users completing course0
-        [102, 103, 104, 106],  # Users completing course1
-        [103, 105, 106],  # Users completing course2
-    ]
+    """Test retrieving data for a learning path."""
+    with patch(patch_target) as mock_retrieve:
+        options = Mock()
+        mock_retrieve.side_effect = (
+            (users[i].id for i in (0, 1, 2, 4, 5)),  # Users passing/completing course0
+            (users[i].id for i in (0, 1, 2, 3, 4, 5)),  # Users passing/completing course1
+            (users[i].id for i in (0, 2, 3, 4, 5)),  # Users passing/completing course2
+        )
 
-    result = retrieve_completions(learning_path_with_courses.key, options)
+        result = function_to_test(learning_path_with_courses.key, options)
 
-    assert sorted(result) == [103, 106]
+        assert sorted(result) == [users[0].id, users[2].id]
 
-    assert mock_retrieve_course_completions.call_count == 3
-    course_keys = [step.course_key for step in learning_path_with_courses.steps.all()]
-    for i, course_key in enumerate(course_keys):
-        call_args = mock_retrieve_course_completions.call_args_list[i]
-        assert call_args[0] == (course_key, options)
+        assert mock_retrieve.call_count == 3
+        course_keys = [step.course_key for step in learning_path_with_courses.steps.all()]
+        for i, course_key in enumerate(course_keys):
+            call_args = mock_retrieve.call_args_list[i]
+            assert call_args[0] == (course_key, options)