learning-credentials 0.2.0rc3__tar.gz → 0.2.2rc1__tar.gz

{learning_credentials-0.2.0rc3 → learning_credentials-0.2.2rc1}/CHANGELOG.rst

@@ -16,13 +16,33 @@ Unreleased
 
 *
 
-0.2.0 – 2025-03-31
+0.2.2 - 2025-08-05
+
+Added
+=====
+
+* Step-specific options support for Learning Path credentials.
+
+Removed
+=======
+
+* Legacy `openedx_certificates` app.
+
+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.0rc3/learning_credentials.egg-info → learning_credentials-0.2.2rc1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-credentials
-Version: 0.2.0rc3
+Version: 0.2.2rc1
 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.4
 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,33 @@ Unreleased
 
 *
 
-0.2.0 – 2025-03-31
+0.2.2 - 2025-08-05
+
+Added
+=====
+
+* Step-specific options support for Learning Path credentials.
+
+Removed
+=======
+
+* Legacy `openedx_certificates` app.
+
+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.0rc3 → learning_credentials-0.2.2rc1}/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.0rc3 → learning_credentials-0.2.2rc1}/learning_credentials/__init__.py

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

{learning_credentials-0.2.0rc3 → learning_credentials-0.2.2rc1}/learning_credentials/compat.py

@@ -5,6 +5,8 @@ This module moderates access to all edx-platform features allowing for cross-ver
 It also simplifies running tests outside edx-platform's environment by stubbing these functions in unit tests.
 """
 
+# ruff: noqa: PLC0415
+
 from __future__ import annotations
 
 from contextlib import contextmanager

{learning_credentials-0.2.0rc3 → learning_credentials-0.2.2rc1}/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.0rc3 → learning_credentials-0.2.2rc1}/learning_credentials/migrations/0001_initial.py

@@ -5,7 +5,7 @@ import model_utils.fields
 import opaque_keys.edx.django.models
 import uuid
 
-import openedx_certificates.models
+import learning_credentials.models
 
 
 class Migration(migrations.Migration):
@@ -39,7 +39,7 @@ class Migration(migrations.Migration):
                     models.FileField(
                         help_text='Asset file. It could be a PDF template, image or font file.',
                         max_length=255,
-                        upload_to=openedx_certificates.models.ExternalCertificateAsset.template_assets_path,
+                        upload_to=learning_credentials.models.CredentialAsset.template_assets_path,
                     ),
                 ),
                 (

learning_credentials-0.2.2rc1/learning_credentials/migrations/0002_migrate_to_learning_credentials.py

@@ -0,0 +1,40 @@
+from django.db import migrations
+
+
+def migrate_data_if_tables_exist(apps, schema_editor):
+    """Migrate data from openedx_certificates to learning_credentials tables if the source tables exist."""
+    connection = schema_editor.connection
+    cursor = connection.cursor()
+    table_names = connection.introspection.table_names(cursor)
+
+    tables_to_migrate = [
+        (
+            "openedx_certificates_externalcertificatetype",
+            "learning_credentials_externalcertificatetype",
+            "id, created, modified, name, retrieval_func, generation_func, custom_options",
+        ),
+        (
+            "openedx_certificates_externalcertificatecourseconfiguration",
+            "learning_credentials_externalcertificatecourseconfiguration",
+            "id, created, modified, course_id, custom_options, certificate_type_id, periodic_task_id",
+        ),
+        (
+            "openedx_certificates_externalcertificateasset",
+            "learning_credentials_externalcertificateasset",
+            "id, created, modified, description, asset, asset_slug",
+        ),
+        (
+            "openedx_certificates_externalcertificate",
+            "learning_credentials_externalcertificate",
+            "uuid, created, modified, user_id, user_full_name, course_id, certificate_type, status, download_url, legacy_id, generation_task_id",
+        ),
+    ]
+
+    for source_table, target_table, fields in tables_to_migrate:
+        if source_table in table_names:
+            cursor.execute(f"INSERT INTO {target_table} ({fields}) SELECT {fields} FROM {source_table};")
+
+
+class Migration(migrations.Migration):
+    dependencies = [("learning_credentials", "0001_initial")]
+    operations = [migrations.RunPython(migrate_data_if_tables_exist, migrations.RunPython.noop)]

learning_credentials-0.2.2rc1/learning_credentials/migrations/0006_cleanup_openedx_certificates_tables.py

@@ -0,0 +1,21 @@
+# Clean up legacy `openedx_certificates` tables.
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("learning_credentials", "0005_rename_processors_and_generators"),
+    ]
+
+    operations = [
+        migrations.RunSQL(
+            sql=[
+                "DROP TABLE IF EXISTS openedx_certificates_externalcertificate;",
+                "DROP TABLE IF EXISTS openedx_certificates_externalcertificateasset;",
+                "DROP TABLE IF EXISTS openedx_certificates_externalcertificatecourseconfiguration;",
+                "DROP TABLE IF EXISTS openedx_certificates_externalcertificatetype;",
+            ],
+            reverse_sql=migrations.RunSQL.noop,
+        ),
+    ]

{learning_credentials-0.2.0rc3 → learning_credentials-0.2.2rc1}/learning_credentials/models.py

@@ -106,7 +106,7 @@ class CredentialConfiguration(TimeStampedModel):
 
     def save(self, *args, **kwargs):
         """Create a new PeriodicTask every time a new CredentialConfiguration is created."""
-        from learning_credentials.tasks import generate_credentials_for_config_task as task  # Avoid circular imports.
+        from learning_credentials.tasks import generate_credentials_for_config_task as task  # noqa: PLC0415
 
         # Use __wrapped__ to get the original function, as the task is wrapped by the @app.task decorator.
         task_path = f"{task.__wrapped__.__module__}.{task.__wrapped__.__name__}"
@@ -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",
@@ -300,7 +300,7 @@ class Credential(TimeStampedModel):
             language='en',
             context={
                 'certificate_link': self.download_url,
-                'course_name': course_name,
+                'course_name': learning_context_name,
                 'platform_name': settings.PLATFORM_NAME,
             },
         )

{learning_credentials-0.2.0rc3 → learning_credentials-0.2.2rc1}/learning_credentials/processors.py

@@ -45,12 +45,14 @@ def _process_learning_context(
     Process a learning context (course or learning path) using the given course processor function.
 
     For courses, runs the processor directly. For learning paths, runs the processor on each
-    course in the path and returns the intersection of eligible users across all courses.
+    course in the path with step-specific options (if available), and returns the intersection
+    of eligible users across all courses.
 
     Args:
         learning_context_key: A course key or learning path key to process
         course_processor: A function that processes a single course and returns eligible user IDs
-        options: Options to pass to the processor
+        options: Options to pass to the processor. For learning paths, may contain a "steps" key
+                with step-specific options in the format: {"steps": {"<course_key>": {...}}}
 
     Returns:
         A list of eligible user IDs
@@ -62,12 +64,19 @@ def _process_learning_context(
 
     results = None
     for course in learning_path.steps.all():
-        course_results = set(course_processor(course.course_key, options))
+        course_options = options.get("steps", {}).get(str(course.course_key), options)
+        course_results = set(course_processor(course.course_key, course_options))
+
         if results is None:
             results = course_results
         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 []
 
 
@@ -182,7 +191,7 @@ def retrieve_subsection_grades(learning_context_key: LearningContextKey, options
     Options:
       - required_grades: A dictionary of required grades for each category, where the keys are the category names and
         the values are the minimum required grades. The grades are percentages, so they should be in the range [0, 1].
-        See the following example::
+        See the following example:
 
           {
             "required_grades": {
@@ -200,6 +209,28 @@ def retrieve_subsection_grades(learning_context_key: LearningContextKey, options
         3. Exam: 70%
         The grades for the Total category will be calculated as follows:
         total_grade = (homework_grade * 0.2) + (lab_grade * 0.1) + (exam_grade * 0.7)
+      - steps: For learning paths only. A dictionary with step-specific options in the format
+        {"&lt;course_key&gt;": {...}}. If provided, each course in the learning path will use its specific
+        options instead of the global options. Example:
+
+          {
+            "required_grades": {
+                "Total": 0.8
+            },
+            "steps": {
+                "course-v1:edX+DemoX+Demo_Course": {
+                    "required_grades": {
+                        "Total": 0.9
+                    }
+                },
+                "course-v1:edX+CS101+2023": {
+                    "required_grades": {
+                        "Homework": 0.5,
+                        "Total": 0.7
+                    }
+                }
+            }
+        }
     """
     return _process_learning_context(learning_context_key, _retrieve_course_subsection_grades, options)
 
@@ -240,6 +271,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.
@@ -271,6 +303,21 @@ def retrieve_completions(learning_context_key: LearningContextKey, options: dict
 
     Options:
       - required_completion: The minimum required completion percentage. The default value is 0.9.
+      - steps: For learning paths only. A dictionary with step-specific options in the format
+        {"&lt;course_key&gt;": {...}}. If provided, each course in the learning path will use its specific
+        options instead of the global options. Example:
+
+          {
+            "required_completion": 0.8,
+            "steps": {
+                "course-v1:edX+DemoX+Demo_Course": {
+                    "required_completion": 0.9
+                },
+                "course-v1:edX+CS101+2023": {
+                    "required_completion": 0.7
+                }
+            }
+        }
     """
     return _process_learning_context(learning_context_key, _retrieve_course_completions, options)
 
@@ -289,8 +336,7 @@ def retrieve_completions_and_grades(learning_context_key: LearningContextKey, op
     Options:
       - required_completion: The minimum required completion percentage (default: 0.9)
       - required_grades: A dictionary of required grades for each category, where the keys are the category names and
-        the values are the minimum required grades. The grades are percentages in the range [0, 1].
-        Example::
+        the values are the minimum required grades. The grades are percentages in the range [0, 1]. Example:
 
           {
             "required_grades": {
@@ -299,6 +345,31 @@ def retrieve_completions_and_grades(learning_context_key: LearningContextKey, op
               "Total": 0.8
             }
           }
+      - steps: For learning paths only. A dictionary with step-specific options in the format
+        {"&lt;course_key&gt;": {...}}. If provided, each course in the learning path will use its specific
+        options instead of the global options. Example:
+
+          {
+            "required_completion": 0.8,
+            "required_grades": {
+              "Total": 0.7
+            },
+            "steps": {
+              "course-v1:edX+DemoX+Demo_Course": {
+                "required_completion": 0.9,
+                "required_grades": {
+                  "Total": 0.8
+                }
+              },
+              "course-v1:edX+CS101+2023": {
+                "required_completion": 0.7,
+                "required_grades": {
+                  "Homework": 0.5,
+                  "Total": 0.6
+                }
+              }
+            }
+          }
     """
     completion_eligible_users = set(retrieve_completions(learning_context_key, options))
     grades_eligible_users = set(retrieve_subsection_grades(learning_context_key, options))

{learning_credentials-0.2.0rc3 → learning_credentials-0.2.2rc1}/learning_credentials/settings/common.py

@@ -7,6 +7,3 @@ def plugin_settings(settings: Settings):
     """Add `django_celery_beat` to `INSTALLED_APPS`."""
     if 'django_celery_beat' not in settings.INSTALLED_APPS:
         settings.INSTALLED_APPS += ('django_celery_beat',)
-    # Temporary app to handle migrations.
-    if 'openedx_certificates' not in settings.INSTALLED_APPS:
-        settings.INSTALLED_APPS += ('openedx_certificates',)

{learning_credentials-0.2.0rc3 → learning_credentials-0.2.2rc1/learning_credentials.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-credentials
-Version: 0.2.0rc3
+Version: 0.2.2rc1
 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.4
 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,33 @@ Unreleased
 
 *
 
-0.2.0 – 2025-03-31
+0.2.2 - 2025-08-05
+
+Added
+=====
+
+* Step-specific options support for Learning Path credentials.
+
+Removed
+=======
+
+* Legacy `openedx_certificates` app.
+
+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.0rc3 → learning_credentials-0.2.2rc1}/learning_credentials.egg-info/SOURCES.txt

@@ -27,6 +27,7 @@ learning_credentials/migrations/0002_migrate_to_learning_credentials.py
 learning_credentials/migrations/0003_rename_certificates_to_credentials.py
 learning_credentials/migrations/0004_replace_course_keys_with_learning_context_keys.py
 learning_credentials/migrations/0005_rename_processors_and_generators.py
+learning_credentials/migrations/0006_cleanup_openedx_certificates_tables.py
 learning_credentials/migrations/__init__.py
 learning_credentials/settings/__init__.py
 learning_credentials/settings/common.py
@@ -37,11 +38,6 @@ learning_credentials/templates/learning_credentials/edx_ace/certificate_generate
 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
-openedx_certificates/migrations/0001_initial.py
-openedx_certificates/migrations/__init__.py
 requirements/base.in
 requirements/constraints.txt
 tests/test_generators.py

{learning_credentials-0.2.0rc3 → learning_credentials-0.2.2rc1}/learning_credentials.egg-info/entry_points.txt

@@ -1,3 +1,2 @@
 [lms.djangoapp]
 learning_credentials = learning_credentials.apps:LearningCredentialsConfig
-openedx_certificates = openedx_certificates.apps:OpenEdxCertificatesConfig

{learning_credentials-0.2.0rc3 → learning_credentials-0.2.2rc1}/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.4
 openedx-completion-aggregator
 pypdf
 reportlab

{learning_credentials-0.2.0rc3 → learning_credentials-0.2.2rc1}/learning_credentials.egg-info/top_level.txt

@@ -1,2 +1 @@
 learning_credentials
-openedx_certificates

{learning_credentials-0.2.0rc3 → learning_credentials-0.2.2rc1}/pyproject.toml

@@ -98,6 +98,9 @@ convention = "google"
 [tool.ruff.lint.pylint]
 allow-magic-value-types = ['int', 'str']
 
+[tool.ruff.format]
+quote-style = "preserve"
+
 [tool.black]
 line-length = 120
 target-version = ['py311']

{learning_credentials-0.2.0rc3 → learning_credentials-0.2.2rc1}/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.4

{learning_credentials-0.2.0rc3 → learning_credentials-0.2.2rc1}/requirements/constraints.txt

@@ -9,4 +9,7 @@
 # linking to it here is good.
 
 # Common constraints for edx repos
--c common_constraints.txt
+-c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
+
+# TODO: Delete this once https://github.com/googleapis/google-auth-library-python/pull/1797 is merged.
+cachetools<6

{learning_credentials-0.2.0rc3 → learning_credentials-0.2.2rc1}/setup.py

@@ -143,13 +143,12 @@ setup(
     author_email='help@opencraft.com',
     url='https://github.com/open-craft/learning-credentials',
     packages=find_packages(
-        include=['learning_credentials', 'learning_credentials.*', 'openedx_certificates', 'openedx_certificates.*'],
+        include=['learning_credentials', 'learning_credentials.*'],
         exclude=["*tests"],
     ),
     entry_points={
         "lms.djangoapp": [
             "learning_credentials = learning_credentials.apps:LearningCredentialsConfig",
-            "openedx_certificates = openedx_certificates.apps:OpenEdxCertificatesConfig",
         ],
     },
     include_package_data=True,

{learning_credentials-0.2.0rc3 → learning_credentials-0.2.2rc1}/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.0rc3 → learning_credentials-0.2.2rc1}/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,85 @@ def test_retrieve_course_completions_and_grades(
 
 
 @pytest.fixture
-def learning_path_with_courses() -> LearningPath:
+def users() -> list[User]:
+    """Create a list of users."""
+    return UserFactory.create_batch(6)
+
+
+@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',
-        slug="test",
-    )
+    learning_path = LearningPath.objects.create(key='path-v1:test+number+run+group')
+
+    for i in range(3):
+        learning_path.steps.create(course_key=f"course-v1:TestX+Test101+2023_{i}", order=i)
 
-    course_keys = [f"course-v1:TestX+Test101+2023_{i}" for i in range(3)]
+    # Enroll all users except the last one.
+    for i in range(len(users) - 1):
+        learning_path.enrolled_users.add(users[i])
 
-    for i, course_key_str in enumerate(course_keys):
-        LearningPathStep.objects.create(learning_path=learning_path, course_key=course_key_str, order=i)
+    # Mark the second last user's enrollment as inactive.
+    learning_path.learningpathenrollment_set.filter(user=users[-2]).update(is_active=False)
 
     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_subsection_grades")
-def test_retrieve_subsection_grades_with_learning_path(
-    mock_retrieve_course_subsection_grades: 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 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
-    ]
+    """Test retrieving data for a learning path."""
+    with patch(patch_target) as mock_retrieve:
+        options = {}
+        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_subsection_grades(learning_path_with_courses.key, options)
+        result = function_to_test(learning_path_with_courses.key, options)
 
-    assert result == [103]
+        assert sorted(result) == [users[0].id, users[2].id]
 
-    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)
+        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)
 
 
-@pytest.mark.django_db
 @patch("learning_credentials.processors._retrieve_course_completions")
-def test_retrieve_completions_with_learning_path_db(
-    mock_retrieve_course_completions: Mock,
+@pytest.mark.django_db
+def test_retrieve_data_for_learning_path_with_step_options(
+    mock_retrieve: Mock,
     learning_path_with_courses: LearningPath,
 ):
-    """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 step-specific options."""
+    course_keys = [step.course_key for step in learning_path_with_courses.steps.all()]
 
-    result = retrieve_completions(learning_path_with_courses.key, options)
+    options = {
+        "required_completion": 0.7,
+        "steps": {
+            str(course_keys[0]): {"required_completion": 0.8},
+            str(course_keys[1]): {"required_completion": 0.9},
+            # course_keys[2] will use base options
+        },
+    }
 
-    assert sorted(result) == [103, 106]
+    retrieve_completions(learning_path_with_courses.key, options)
 
-    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
+    assert mock_retrieve.call_args_list[0][0] == (course_keys[0], options["steps"][str(course_keys[0])])
+    assert mock_retrieve.call_args_list[1][0] == (course_keys[1], options["steps"][str(course_keys[1])])
+    assert mock_retrieve.call_args_list[2][0] == (course_keys[2], options)

learning_credentials-0.2.0rc3/learning_credentials/migrations/0002_migrate_to_learning_credentials.py

@@ -1,32 +0,0 @@
-from django.db import migrations
-
-
-class Migration(migrations.Migration):
-    dependencies = [
-        ('openedx_certificates', '0001_initial'),
-        ('learning_credentials', '0001_initial'),
-    ]
-
-    operations = [
-        migrations.RunSQL(
-            sql=[
-                "INSERT INTO learning_credentials_externalcertificatetype (id, created, modified, name, retrieval_func, generation_func, custom_options) "
-                "SELECT id, created, modified, name, retrieval_func, generation_func, custom_options FROM openedx_certificates_externalcertificatetype;",
-
-                "INSERT INTO learning_credentials_externalcertificatecourseconfiguration (id, created, modified, course_id, custom_options, certificate_type_id, periodic_task_id) "
-                "SELECT id, created, modified, course_id, custom_options, certificate_type_id, periodic_task_id FROM openedx_certificates_externalcertificatecourseconfiguration;",
-
-                "INSERT INTO learning_credentials_externalcertificateasset (id, created, modified, description, asset, asset_slug) "
-                "SELECT id, created, modified, description, asset, asset_slug FROM openedx_certificates_externalcertificateasset;",
-
-                "INSERT INTO learning_credentials_externalcertificate (uuid, created, modified, user_id, user_full_name, course_id, certificate_type, status, download_url, legacy_id, generation_task_id) "
-                "SELECT uuid, created, modified, user_id, user_full_name, course_id, certificate_type, status, download_url, legacy_id, generation_task_id FROM openedx_certificates_externalcertificate;",
-            ],
-            reverse_sql=[
-                "DELETE FROM learning_credentials_externalcertificate;",
-                "DELETE FROM learning_credentials_externalcertificatecourseconfiguration;",
-                "DELETE FROM learning_credentials_externalcertificateasset;",
-                "DELETE FROM learning_credentials_externalcertificatetype;",
-            ],
-        ),
-    ]

learning_credentials-0.2.0rc3/openedx_certificates/__init__.py

@@ -1 +0,0 @@
-"""Legacy module for Open edX certificates. It exists for backward compatibility."""

learning_credentials-0.2.0rc3/openedx_certificates/apps.py

@@ -1,11 +0,0 @@
-"""openedx_certificates Django application initialization."""
-
-from __future__ import annotations
-
-from django.apps import AppConfig
-
-
-class OpenedxCertificatesConfig(AppConfig):
-    """Configuration for the openedx_certificates Django application."""
-
-    name = 'openedx_certificates'

learning_credentials-0.2.0rc3/openedx_certificates/migrations/0001_initial.py

@@ -1,206 +0,0 @@
-# Generated by Django 3.2.23 on 2023-11-14 15:54
-
-from django.db import migrations, models
-import django.db.models.deletion
-import django.utils.timezone
-import jsonfield.fields
-import model_utils.fields
-import opaque_keys.edx.django.models
-import openedx_certificates.models
-import uuid
-
-
-class Migration(migrations.Migration):
-    initial = True
-
-    dependencies = [
-        ('django_celery_beat', '0018_improve_crontab_helptext'),
-    ]
-
-    operations = [
-        migrations.CreateModel(
-            name='ExternalCertificateAsset',
-            fields=[
-                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                (
-                    'created',
-                    model_utils.fields.AutoCreatedField(
-                        default=django.utils.timezone.now, editable=False, verbose_name='created'
-                    ),
-                ),
-                (
-                    'modified',
-                    model_utils.fields.AutoLastModifiedField(
-                        default=django.utils.timezone.now, editable=False, verbose_name='modified'
-                    ),
-                ),
-                ('description', models.CharField(blank=True, help_text='Description of the asset.', max_length=255)),
-                (
-                    'asset',
-                    models.FileField(
-                        help_text='Asset file. It could be a PDF template, image or font file.',
-                        max_length=255,
-                        upload_to=openedx_certificates.models.ExternalCertificateAsset.template_assets_path,
-                    ),
-                ),
-                (
-                    'asset_slug',
-                    models.SlugField(
-                        help_text="Asset's unique slug. We can reference the asset in templates using this value.",
-                        max_length=255,
-                        unique=True,
-                    ),
-                ),
-            ],
-            options={
-                'get_latest_by': 'created',
-            },
-        ),
-        migrations.CreateModel(
-            name='ExternalCertificateType',
-            fields=[
-                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                (
-                    'created',
-                    model_utils.fields.AutoCreatedField(
-                        default=django.utils.timezone.now, editable=False, verbose_name='created'
-                    ),
-                ),
-                (
-                    'modified',
-                    model_utils.fields.AutoLastModifiedField(
-                        default=django.utils.timezone.now, editable=False, verbose_name='modified'
-                    ),
-                ),
-                ('name', models.CharField(help_text='Name of the certificate type.', max_length=255, unique=True)),
-                (
-                    'retrieval_func',
-                    models.CharField(help_text='A name of the function to retrieve eligible users.', max_length=200),
-                ),
-                (
-                    'generation_func',
-                    models.CharField(help_text='A name of the function to generate certificates.', max_length=200),
-                ),
-                (
-                    'custom_options',
-                    jsonfield.fields.JSONField(blank=True, default=dict, help_text='Custom options for the functions.'),
-                ),
-            ],
-            options={
-                'abstract': False,
-            },
-        ),
-        migrations.CreateModel(
-            name='ExternalCertificate',
-            fields=[
-                (
-                    'created',
-                    model_utils.fields.AutoCreatedField(
-                        default=django.utils.timezone.now, editable=False, verbose_name='created'
-                    ),
-                ),
-                (
-                    'modified',
-                    model_utils.fields.AutoLastModifiedField(
-                        default=django.utils.timezone.now, editable=False, verbose_name='modified'
-                    ),
-                ),
-                (
-                    'uuid',
-                    models.UUIDField(
-                        default=uuid.uuid4,
-                        editable=False,
-                        help_text='Auto-generated UUID of the certificate',
-                        primary_key=True,
-                        serialize=False,
-                    ),
-                ),
-                ('user_id', models.IntegerField(help_text='ID of the user receiving the certificate')),
-                ('user_full_name', models.CharField(help_text='User receiving the certificate', max_length=255)),
-                (
-                    'course_id',
-                    opaque_keys.edx.django.models.CourseKeyField(
-                        help_text='ID of a course for which the certificate was issued', max_length=255
-                    ),
-                ),
-                ('certificate_type', models.CharField(help_text='Type of the certificate', max_length=255)),
-                (
-                    'status',
-                    models.CharField(
-                        choices=[
-                            ('generating', 'Generating'),
-                            ('available', 'Available'),
-                            ('error', 'Error'),
-                            ('invalidated', 'Invalidated'),
-                        ],
-                        default='generating',
-                        help_text='Status of the certificate generation task',
-                        max_length=32,
-                    ),
-                ),
-                (
-                    'download_url',
-                    models.URLField(blank=True, help_text='URL of the generated certificate PDF (e.g., to S3)'),
-                ),
-                (
-                    'legacy_id',
-                    models.IntegerField(
-                        help_text='Legacy ID of the certificate imported from another system', null=True
-                    ),
-                ),
-                ('generation_task_id', models.CharField(help_text='Task ID from the Celery queue', max_length=255)),
-            ],
-            options={
-                'unique_together': {('user_id', 'course_id', 'certificate_type')},
-            },
-        ),
-        migrations.CreateModel(
-            name='ExternalCertificateCourseConfiguration',
-            fields=[
-                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                (
-                    'created',
-                    model_utils.fields.AutoCreatedField(
-                        default=django.utils.timezone.now, editable=False, verbose_name='created'
-                    ),
-                ),
-                (
-                    'modified',
-                    model_utils.fields.AutoLastModifiedField(
-                        default=django.utils.timezone.now, editable=False, verbose_name='modified'
-                    ),
-                ),
-                (
-                    'course_id',
-                    opaque_keys.edx.django.models.CourseKeyField(help_text='The ID of the course.', max_length=255),
-                ),
-                (
-                    'custom_options',
-                    jsonfield.fields.JSONField(
-                        blank=True,
-                        default=dict,
-                        help_text='Custom options for the functions. If specified, they are merged with the options defined in the certificate type.',
-                    ),
-                ),
-                (
-                    'certificate_type',
-                    models.ForeignKey(
-                        help_text='Associated certificate type.',
-                        on_delete=django.db.models.deletion.CASCADE,
-                        to='openedx_certificates.externalcertificatetype',
-                    ),
-                ),
-                (
-                    'periodic_task',
-                    models.OneToOneField(
-                        help_text='Associated periodic task.',
-                        on_delete=django.db.models.deletion.CASCADE,
-                        to='django_celery_beat.periodictask',
-                    ),
-                ),
-            ],
-            options={
-                'unique_together': {('course_id', 'certificate_type')},
-            },
-        ),
-    ]

learning_credentials-0.2.0rc3/openedx_certificates/models.py

@@ -1,38 +0,0 @@
-"""
-Proxy models for backward compatibility with the old app structure.
-
-These will redirect to the new models in learning_credentials.
-"""
-
-from learning_credentials.models import Credential as LearningCredential
-from learning_credentials.models import CredentialAsset as LearningCredentialAsset
-from learning_credentials.models import CredentialConfiguration as LearningCredentialConfiguration
-from learning_credentials.models import CredentialType as LearningCredentialType
-
-
-class ExternalCertificate(LearningCredential):
-    """Proxy model for backward compatibility."""
-
-    class Meta:  # noqa: D106
-        proxy = True
-
-
-class ExternalCertificateAsset(LearningCredentialAsset):
-    """Proxy model for backward compatibility."""
-
-    class Meta:  # noqa: D106
-        proxy = True
-
-
-class ExternalCertificateType(LearningCredentialType):
-    """Proxy model for backward compatibility."""
-
-    class Meta:  # noqa: D106
-        proxy = True
-
-
-class ExternalCertificateCourseConfiguration(LearningCredentialConfiguration):
-    """Proxy model for backward compatibility."""
-
-    class Meta:  # noqa: D106
-        proxy = True