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

{learning_credentials-0.2.0rc3 → learning_credentials-0.2.2}/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.2}/PKG-INFO

@@ -1,17 +1,17 @@
 Metadata-Version: 2.4
 Name: learning-credentials
-Version: 0.2.0rc3
+Version: 0.2.2
 Summary: A pluggable service for preparing Open edX credentials.
-Home-page: https://github.com/open-craft/learning-credentials
-Author: OpenCraft
-Author-email: help@opencraft.com
-License: AGPL 3.0
-Keywords: Python edx
-Classifier: Development Status :: 3 - Alpha
+Author-email: OpenCraft <help@opencraft.com>
+License-Expression: AGPL-3.0-or-later
+Project-URL: Homepage, https://github.com/open-craft/learning-credentials
+Project-URL: Repository, https://github.com/open-craft/learning-credentials
+Project-URL: Documentation, https://learning-credentials.readthedocs.io/
+Keywords: Python,edx,credentials,django
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Django
 Classifier: Framework :: Django :: 4.2
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
@@ -19,31 +19,20 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
-Requires-Dist: celery
 Requires-Dist: django
-Requires-Dist: django-celery-beat
 Requires-Dist: django-model-utils
-Requires-Dist: django-object-actions
+Requires-Dist: edx-opaque-keys
+Requires-Dist: celery
+Requires-Dist: django-celery-beat
 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: openedx-completion-aggregator
+Requires-Dist: django-object-actions
 Requires-Dist: pypdf
 Requires-Dist: reportlab
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
+Requires-Dist: openedx-completion-aggregator
+Requires-Dist: edx_ace
+Requires-Dist: learning-paths-plugin>=0.3.4
 Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
 
 learning-credentials
 ####################
@@ -139,7 +128,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 +148,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/
@@ -167,7 +156,6 @@ Please do not report security issues in public. Please email security@openedx.or
     :target: https://mango-dune-07a8b7110.1.azurestaticapps.net/?repo=open-craft/learning-credentials
     :alt: Visualization
 
-
 Change Log
 ##########
 
@@ -186,13 +174,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.2}/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.2}/learning_credentials/__init__.py

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

{learning_credentials-0.2.0rc3 → learning_credentials-0.2.2}/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.2/learning_credentials/conf/locale/config.yaml

@@ -0,0 +1,85 @@
+# Configuration for i18n workflow.
+
+locales:
+    - en  # English - Source Language
+    - am  # Amharic
+    - ar  # Arabic
+    - az  # Azerbaijani
+    - bg_BG  # Bulgarian (Bulgaria)
+    - bn_BD  # Bengali (Bangladesh)
+    - bn_IN  # Bengali (India)
+    - bs  # Bosnian
+    - ca  # Catalan
+    - ca@valencia  # Catalan (Valencia)
+    - cs  # Czech
+    - cy  # Welsh
+    - da  # Danish
+    - de_DE  # German (Germany)
+    - el  # Greek
+    - en  # English
+    - en_GB  # English (United Kingdom)
+    # Don't pull these until we figure out why pages randomly display in these locales,
+    # when the user's browser is in English and the user is not logged in.
+    # - en@lolcat  # LOLCAT English
+    # - en@pirate  # Pirate English
+    - es_419  # Spanish (Latin America)
+    - es_AR  # Spanish (Argentina)
+    - es_EC  # Spanish (Ecuador)
+    - es_ES  # Spanish (Spain)
+    - es_MX  # Spanish (Mexico)
+    - es_PE  # Spanish (Peru)
+    - et_EE  # Estonian (Estonia)
+    - eu_ES  # Basque (Spain)
+    - fa  # Persian
+    - fa_IR  # Persian (Iran)
+    - fi_FI  # Finnish (Finland)
+    - fil  # Filipino
+    - fr  # French
+    - gl  # Galician
+    - gu  # Gujarati
+    - he  # Hebrew
+    - hi  # Hindi
+    - hr  # Croatian
+    - hu  # Hungarian
+    - hy_AM  # Armenian (Armenia)
+    - id  # Indonesian
+    - it_IT  # Italian (Italy)
+    - ja_JP  # Japanese (Japan)
+    - kk_KZ  # Kazakh (Kazakhstan)
+    - km_KH  # Khmer (Cambodia)
+    - kn  # Kannada
+    - ko_KR  # Korean (Korea)
+    - lt_LT  # Lithuanian (Lithuania)
+    - ml  # Malayalam
+    - mn  # Mongolian
+    - mr  # Marathi
+    - ms  # Malay
+    - nb  # Norwegian Bokmål
+    - ne  # Nepali
+    - nl_NL  # Dutch (Netherlands)
+    - or  # Oriya
+    - pl  # Polish
+    - pt_BR  # Portuguese (Brazil)
+    - pt_PT  # Portuguese (Portugal)
+    - ro  # Romanian
+    - ru  # Russian
+    - si  # Sinhala
+    - sk  # Slovak
+    - sl  # Slovenian
+    - sq  # Albanian
+    - sr  # Serbian
+    - ta  # Tamil
+    - te  # Telugu
+    - th  # Thai
+    - tr_TR  # Turkish (Turkey)
+    - uk  # Ukranian
+    - ur  # Urdu
+    - uz  # Uzbek
+    - vi  # Vietnamese
+    - zh_CN  # Chinese (China)
+    - zh_HK  # Chinese (Hong Kong)
+    - zh_TW  # Chinese (Taiwan)
+
+# The locales used for fake-accented English, for testing.
+dummy_locales:
+    - eo

{learning_credentials-0.2.0rc3 → learning_credentials-0.2.2}/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.2}/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.2/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.2/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.2}/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.2}/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 []
 
 
@@ -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,32 @@ 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.2}/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',)