learning-credentials 0.5.1rc1
A pluggable service for preparing Open edX credentials.
Requires Python: >=3.11
Keywords: Python, edx, credentials, django

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 help@opencraft.com.

.. |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/actions/workflows/ci.yml/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-Maintained-brightgreen
    :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.5.1 - 2026-02-13
******************

Added
=====

* Eligibility REST API endpoint.

0.5.0 - 2026-01-29
******************

Added
=====

* Credential validation and invalidation system with ``INVALIDATED`` status.
* ``verify_uuid`` field on credentials — a separate UUID used for third-party verification, distinct from the primary key.
* ``invalidated_at`` timestamp and ``invalidation_reason`` fields on the ``Credential`` model.
* ``learning_context_name`` cached field on credentials for use in validation display.
* Public API endpoint (``/api/learning_credentials/v1/metadata/<uuid>/``) to retrieve credential metadata by verification UUID.
* "Reissue credential" admin action that invalidates the current credential and generates a new one.
* ``{verify_uuid}`` placeholder support in PDF text elements.
* Admin test suite (``test_admin.py``) and included it in test coverage.

Changed
=======

* Replaced ``user_id`` (IntegerField) with a ``user`` ForeignKey to the User model.
* Added ``configuration`` ForeignKey on ``Credential`` linking to ``CredentialConfiguration``, replacing ``credential_type`` and ``learning_context_key`` lookups.
* Simplified ``generate_pdf_credential()`` signature to accept a ``Credential`` object instead of separate parameters.
* Changed the PDF output directory from hardcoded ``external_certificates/`` to the configurable ``LEARNING_CREDENTIALS_OUTPUT_DIR`` setting.
* Credential issue date on PDFs now uses the credential's creation date instead of the current time.
* ``get_localized_credential_date()`` now accepts an explicit ``datetime`` parameter.
* Disabled add and delete permissions for credentials in the Django admin.

0.4.0 - 2026-01-28
******************

Added
=====

* New ``text_elements`` format for PDF credential generation with flexible text positioning and placeholder support.
* Support for custom text elements with ``{name}``, ``{context_name}``, and ``{issue_date}`` placeholders.
* Global ``defaults`` configuration for font, color, and character spacing.

Modified
========

* Migrated generator options from flat format (``name_y``, ``context_name_color``, etc.) to structured ``text_elements`` format.

0.3.1 - 2025-12-15
******************

Added
=====

* Support for defining the course name using the ``cert_name_long`` field (in Studio's Advanced Settings).
* Support for specifying individual fonts for PDF text elements.
* Support for \n in learning context names in PDF certificates.
* Options for uppercase name and issue date in PDF certificates.
* Option for defining character spacing for issue date in PDF certificates.
* Option for defining the horizontal offset of the issue date from its centered position (``issue_date_x``).

Modified
========

* Replaced ``template_two_lines`` with ``template_multiline``.

0.3.0 - 2025-09-17
******************

Added
=====

* REST API endpoint to check if credentials are configured for a learning context.

0.2.4 - 2025-09-07

Added
=====

* Option to customize the learner's name size on the PDF certificate.

0.2.3 - 2025-08-18

Modified
========

* Certificate email template wording.

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
=====

* Learning Paths support.


0.1.0 – 2025-01-29
******************

Added
=====

* Initial implementation of the certificates app.