learning-credentials 0.2.0rc1__py2.py3-none-any.whl

learning_credentials/settings/common.py

@@ -0,0 +1,12 @@
+"""App-specific settings for all environments."""
+
+from django.conf import Settings
+
+
+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/settings/production.py

@@ -0,0 +1,13 @@
+"""App-specific settings for production environments."""
+
+from django.conf import Settings
+
+
+def plugin_settings(settings: Settings):
+    """
+    Use the database scheduler for Celery Beat.
+
+    The default scheduler is celery.beat.PersistentScheduler, which stores the schedule in a local file. It does not
+    work in a multi-server environment, so we use the database scheduler instead.
+    """
+    settings.CELERYBEAT_SCHEDULER = 'django_celery_beat.schedulers:DatabaseScheduler'

learning_credentials/tasks.py

@@ -0,0 +1,53 @@
+"""Asynchronous Celery tasks."""
+
+from __future__ import annotations
+
+import logging
+
+from learning_credentials.compat import get_celery_app
+from learning_credentials.models import CredentialConfiguration
+
+app = get_celery_app()
+log = logging.getLogger(__name__)
+
+
+@app.task
+def generate_credential_for_user_task(config_id: int, user_id: int):
+    """
+    Celery task for processing a single user's credential.
+
+    :param config_id: The ID of the CredentialConfiguration object to process.
+    :param user_id: The ID of the user to process the credential for.
+    """
+    config = CredentialConfiguration.objects.get(id=config_id)
+    config.generate_credential_for_user(user_id, generate_credential_for_user_task.request.id)
+
+
+@app.task
+def generate_credentials_for_config_task(config_id: int):
+    """
+    Celery task for processing a single context's credentials.
+
+    :param config_id: The ID of the CredentialConfiguration object to process.
+    """
+    config = CredentialConfiguration.objects.get(id=config_id)
+    user_ids = config.get_eligible_user_ids()
+    log.info("The following users are eligible in %s: %s", config.learning_context_key, user_ids)
+    filtered_user_ids = config.filter_out_user_ids_with_credentials(user_ids)
+    log.info("The filtered users eligible in %s: %s", config.learning_context_key, filtered_user_ids)
+
+    for user_id in filtered_user_ids:
+        generate_credential_for_user_task.delay(config_id, user_id)
+
+
+@app.task
+def generate_all_credentials_task():
+    """
+    Celery task for initiating the processing of credentials for all enabled contexts.
+
+    This function fetches all enabled CredentialConfiguration objects,
+    and initiates a separate Celery task for each of them.
+    """
+    config_ids = CredentialConfiguration.get_enabled_configurations().values_list('id', flat=True)
+    for config_id in config_ids:
+        generate_credentials_for_config_task.delay(config_id)

learning_credentials/templates/learning_credentials/base.html

@@ -0,0 +1,22 @@
+
+{% comment %}
+As the developer of this package, don't place anything here if you can help it
+since this allows developers to have interoperability between your template
+structure and their own.
+
+Example: Developer melding the 2SoD pattern to fit inside with another pattern::
+
+    {% extends "base.html" %}
+    {% load static %}
+
+    <!-- Their site uses old school block layout -->
+    {% block extra_js %}
+
+        <!-- Your package using 2SoD block layout -->
+        {% block javascript %}
+            <script src="{% static 'js/ninja.js' %}" type="text/javascript"></script>
+        {% endblock javascript %}
+
+    {% endblock extra_js %}
+{% endcomment %}
+

learning_credentials/templates/learning_credentials/edx_ace/certificate_generated/email/body.html

@@ -0,0 +1,22 @@
+{% load i18n %}{% autoescape off %}
+
+<p>
+    {% blocktrans %}Thank you for your participation in {{ course_name }} at {{ platform_name }}!{% endblocktrans %}
+</p>
+
+<p>
+    {% 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 %}
+</p>
+
+<p>
+    {% trans "To view and download your certificate, please click on the following link:" %}
+</p>
+<p><a href="{{ certificate_link }}">View and download your certificate</a></p>
+
+<div>
+    <div>
+        {% blocktrans %}Thank you for choosing {{ platform_name }} for your learning journey. We look forward to seeing you in more courses in the future.{% endblocktrans %}
+    </div>
+</div>
+
+{% endautoescape %}

learning_credentials/urls.py

@@ -0,0 +1,9 @@
+"""URLs for learning_credentials."""
+
+# from django.urls import re_path  # noqa: ERA001, RUF100
+# from django.views.generic import TemplateView  # noqa: ERA001, RUF100
+
+urlpatterns = [  # pragma: no cover
+    # TODO: Fill in URL patterns and views here.
+    # re_path(r'', TemplateView.as_view(template_name="learning_credentials/base.html")),  # noqa: ERA001, RUF100
+]

learning_credentials/views.py

@@ -0,0 +1 @@
+"""TODO."""

learning_credentials-0.2.0rc1.dist-info/METADATA

@@ -0,0 +1,204 @@
+Metadata-Version: 2.4
+Name: learning-credentials
+Version: 0.2.0rc1
+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
+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
+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: 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: pypdf
+Requires-Dist: reportlab
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+learning-credentials
+####################
+
+|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|
+|license-badge| |status-badge| |visualization-badge|
+
+Purpose
+*******
+
+A pluggable service for preparing Open edX credentials.
+
+This is focused on the use cases of our client but designed to be a flexible foundation for any Open edX credential
+needs. It natively supports generating PDF credentials, but can be extended to support other formats.
+
+For the details about the purpose of this repository, please see the `the following ADR`_.
+
+.. _the following ADR: https://learning-credentials.readthedocs.io/en/latest/decisions/0001-purpose-of-this-repo.html
+
+Documentation
+*************
+
+Start by going through `the documentation`_.
+
+.. _the documentation: https://learning-credentials.readthedocs.io/en/latest
+
+Getting Help
+************
+
+If you're having trouble, we have discussion forums at
+https://discuss.openedx.org where you can connect with others in the
+community.
+
+Our real-time conversations are on Slack. You can request a `Slack
+invitation`_, then join our `community Slack workspace`_.
+
+For anything non-trivial, the best path is to open an issue in this
+repository with as many details about the issue you are facing as you
+can provide.
+
+https://github.com/open-craft/learning-credentials/issues
+
+For more information about these options, see the `Getting Help <https://openedx.org/getting-help>`__ page.
+
+.. _Slack invitation: https://openedx.org/slack
+.. _community Slack workspace: https://openedx.slack.com/
+
+License
+*******
+
+The code in this repository is licensed under the AGPL 3.0 unless
+otherwise noted.
+
+Please see `LICENSE.txt <LICENSE.txt>`_ for details.
+
+Contributing
+************
+
+Contributions are very welcome.
+Please read `How To Contribute <https://openedx.org/r/how-to-contribute>`_ for details.
+
+This project is currently accepting all types of contributions, bug fixes,
+security fixes, maintenance work, or new features.  However, please make sure
+to have a discussion about your new feature idea with the maintainers prior to
+beginning development to maximize the chances of your change being accepted.
+You can start a conversation by creating a new issue on this repo summarizing
+your idea.
+
+The Open edX Code of Conduct
+****************************
+
+All community members are expected to follow the `Open edX Code of Conduct`_.
+
+.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/
+
+People
+******
+
+.. TODO: Add the maintainers.
+
+The assigned maintainers for this component and other project details may be
+found in `Backstage`_. Backstage pulls this data from the ``catalog-info.yaml``
+file in this repo.
+
+.. _Backstage: https://backstage.openedx.org/catalog/default/component/learning-credentials
+
+Reporting Security Issues
+*************************
+
+Please do not report security issues in public. Please email security@openedx.org.
+
+.. |pypi-badge| image:: https://img.shields.io/pypi/v/learning-credentials.svg
+    :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
+    :target: https://github.com/open-craft/learning-credentials/actions
+    :alt: CI
+
+.. |codecov-badge| image:: https://codecov.io/github/open-craft/learning-credentials/coverage.svg?branch=main
+    :target: https://codecov.io/github/open-craft/learning-credentials?branch=main
+    :alt: Codecov
+
+.. |doc-badge| image:: https://readthedocs.org/projects/learning-credentials/badge/?version=latest
+    :target: https://learning-credentials.readthedocs.io/en/latest
+    :alt: Documentation
+
+.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/learning-credentials.svg
+    :target: https://pypi.python.org/pypi/learning-credentials/
+    :alt: Supported Python versions
+
+.. |license-badge| image:: https://img.shields.io/github/license/open-craft/learning-credentials.svg
+    :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
+    :alt: Status
+
+.. https://githubnext.com/projects/repo-visualization/
+.. |visualization-badge| image:: https://img.shields.io/badge/Repo%20Visualization-8A2BE2
+    :target: https://mango-dune-07a8b7110.1.azurestaticapps.net/?repo=open-craft/learning-credentials
+    :alt: Visualization
+
+
+Change Log
+##########
+
+..
+   All enhancements and patches to learning_credentials will be documented
+   in this file.  It adheres to the structure of https://keepachangelog.com/ ,
+   but in reStructuredText instead of Markdown (for ease of incorporation into
+   Sphinx documentation and the PyPI description).
+
+   This project adheres to Semantic Versioning (https://semver.org/).
+
+.. There should always be an "Unreleased" section for changes pending release.
+
+Unreleased
+**********
+
+*
+
+0.2.0 – 2025-03-31
+******************
+
+Added
+=====
+
+* Initial implementation of the certificates app.
+
+
+0.1.0 – 2025-01-29
+******************
+
+Added
+=====
+
+* Initial implementation of the certificates app.

learning_credentials-0.2.0rc1.dist-info/RECORD

@@ -0,0 +1,34 @@
+learning_credentials/__init__.py,sha256=VP6jLAbAcydui1q8-rUc2a3RBFNikScVyKa7zStUqCg,88
+learning_credentials/admin.py,sha256=zES_NeA4yS3b0NcRIErA6nkX7xpphRzb_Dk1R_sfFKE,10293
+learning_credentials/apps.py,sha256=AA6JYUyqKYvNJ5POtQKw_s1g1VrUXuQI96hbea9H220,761
+learning_credentials/compat.py,sha256=3SE0CwWJHSNHlRMOm2NZd8zzIY3DKSBCRPBXi7QrWUY,4524
+learning_credentials/exceptions.py,sha256=UaqBVXFMWR2Iob7_LMb3j4NNVmWQFAgLi_MNMRUvGsI,290
+learning_credentials/generators.py,sha256=nktM3gDFv66BzXDJ8wjmjlIz9KWMmBPGlD93jS1WgcU,8821
+learning_credentials/models.py,sha256=28IKCRKXXILRRLCIQxTMasSn7s1m2n8Jf-0euvw6T-A,16035
+learning_credentials/processors.py,sha256=VoM7ybSSiC2kakNHep6PeZkWFE7FZeYdhdU97IOJ0vw,12466
+learning_credentials/tasks.py,sha256=byoFEUvN_ayVaU5K5SlEiA7vu9BRPaSSmKnB9g5toec,1927
+learning_credentials/urls.py,sha256=2YLZZW738D7Afyzq6hr5ajWIl6azmX-hNDGUg_8AFpE,370
+learning_credentials/views.py,sha256=1iBgQYelVHO_QWtoUZfVeyUc0o89IxQWAIwjPjaYaBQ,12
+learning_credentials/migrations/0001_initial.py,sha256=8ycj1lIoI1OG0Pzk3HdB6N94KLe78rUJh9KhqOxlxK4,8444
+learning_credentials/migrations/0002_migrate_to_learning_credentials.py,sha256=B6csbk6yedautmkVwk4PL0k0Yyf9dak-kFFBKUytriw,2006
+learning_credentials/migrations/0003_rename_certificates_to_credentials.py,sha256=YqSaHTB60VNc9k245um2GYVDH6J0l9BrN3ak6WKljjk,4677
+learning_credentials/migrations/0004_replace_course_keys_with_learning_context_keys.py,sha256=5KaXvASl69qbEaHX5_Ty_3Dr7K4WV6p8VWOx72yJnTU,1919
+learning_credentials/migrations/0005_rename_processors_and_generators.py,sha256=5UCqjq-CBJnRo1qBAoWs91ngyEuSMN8_tQtfzsuR5SI,5271
+learning_credentials/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+learning_credentials/settings/__init__.py,sha256=tofc5eg3Q2lV13Ff_jjg1ggGgWpKYoeESkP1qxl3H_A,29
+learning_credentials/settings/common.py,sha256=_-HsQFH39LoxivuZKGxdfGAxU9T0WR2Iep0E6sWqkqM,467
+learning_credentials/settings/production.py,sha256=yEvsCldHOdsIswW7TPLW__b9YNEK-Qy05rX5WSAcEeo,484
+learning_credentials/templates/learning_credentials/base.html,sha256=wtjBYqfHmOnyEY5tN3VGOmzYLsOD24MXdEUhTZ7OmwI,662
+learning_credentials/templates/learning_credentials/edx_ace/certificate_generated/email/body.html,sha256=o-tfFQSNf-tuu_YzPosm0SFxUXe9oPh17PyjdiVSBhQ,811
+learning_credentials/templates/learning_credentials/edx_ace/certificate_generated/email/head.html,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+learning_credentials-0.2.0rc1.dist-info/licenses/LICENSE.txt,sha256=GDpsPnW_1NKhPvZpZL9imz25P2nIpbwJPEhrlq4vPAU,34523
+openedx_certificates/__init__.py,sha256=8OoQEjyyrcDZkrdGAWZ5TcmTJf7orJNJKo83-DFQRXo,85
+openedx_certificates/apps.py,sha256=KZ27RPqxCM-DxBftfAsPrToprUh1yPVPQPBV3qgTJXo,287
+openedx_certificates/models.py,sha256=O749LzwZr7O5js_21Ca_nUGJr-y3WJs__OrjBYXnZ-I,1131
+openedx_certificates/migrations/0001_initial.py,sha256=8pN1xEEecBrXKIleuKbZ_FTlTMoOOGiC0Ibk0tDzriM,8522
+openedx_certificates/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+learning_credentials-0.2.0rc1.dist-info/METADATA,sha256=vQv3xj4X8io3NFfQMDWx95iQu8jUfRpbPXUTVxTbH1U,6621
+learning_credentials-0.2.0rc1.dist-info/WHEEL,sha256=MAQBAzGbXNI3bUmkDsiV_duv8i-gcdnLzw7cfUFwqhU,109
+learning_credentials-0.2.0rc1.dist-info/entry_points.txt,sha256=Ll51HUyeZ2UnWjOXHSx09FPTFs9VMIwDccq-mn2wFEc,166
+learning_credentials-0.2.0rc1.dist-info/top_level.txt,sha256=IC4tbU9MNfH-NkPgSUzE0UEurEMTpK3TJPHmeRf7kVQ,42
+learning_credentials-0.2.0rc1.dist-info/RECORD,,

learning_credentials-0.2.0rc1.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: setuptools (78.1.0)
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any
+

learning_credentials-0.2.0rc1.dist-info/entry_points.txt

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