Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

learning-credentials

PyPI CI Codecov Documentation Supported Python versions License Status Visualization

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.

Documentation

Start by going through the documentation.

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 page.

License

The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.

Please see LICENSE.txt for details.

Contributing

Contributions are very welcome. Please read 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.

People

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.

Reporting Security Issues

Please do not report security issues in public. Please email help@opencraft.com.

Change Log

Unreleased

0.5.3 - 2026-08-11

Fixed

  • The is_generation_enabled field of the credential eligibility endpoint is now based on the expires field of the periodic task, when it is set. The enabled flag is updated by Celery Beat (e.g., it disables expired and already executed one-off tasks), so it does not reliably reflect the intended configuration.

0.5.2 - 2026-08-11

Changed

  • The CredentialAdmin list view is now ordered by the created timestamp in descending order (most recent first).

Removed

  • CredentialAdmin and CredentialConfigurationAdmin list views no longer allow filtering by the learning_context_key.

0.5.1 - 2026-03-17

Added

  • Credential eligibility check endpoint (GET /api/learning_credentials/v1/eligibility/<learning_context_key>/) with detailed progress information.

Changed

  • Processor functions now return dict[int, dict[str, Any]] with detailed eligibility information instead of list[int] of eligible user IDs.

  • Processor functions now accept an optional user_id parameter for single-user eligibility checks.

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

learning_credentials-0.5.3rc1.tar.gz (80.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

learning_credentials-0.5.3rc1-py3-none-any.whl (64.3 kB view details)

Uploaded Python 3

File details

Details for the file learning_credentials-0.5.3rc1.tar.gz.

File metadata

  • Download URL: learning_credentials-0.5.3rc1.tar.gz
  • Upload date:
  • Size: 80.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for learning_credentials-0.5.3rc1.tar.gz
Algorithm Hash digest
SHA256 b4117b556174ab320f6369cc4d884cbb1fc52897de71688d820d2b29b678c5a6
MD5 b0baa802011af7e126e7d333f781d730
BLAKE2b-256 4683ea82106fddf0bdfae9d1f70e819369b1e32a3fec406c6a9adea9165f381d

See more details on using hashes here.

File details

Details for the file learning_credentials-0.5.3rc1-py3-none-any.whl.

File metadata

  • Download URL: learning_credentials-0.5.3rc1-py3-none-any.whl
  • Upload date:
  • Size: 64.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for learning_credentials-0.5.3rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 5469fb8aba99af39d1b97ed2dd466e8f730634832c4fdd20724712eed7b0c19c
MD5 dbcc356e4a1c6cf4cd9af6432ef2b1fa
BLAKE2b-256 383b786cb7e85d6e76844d723446a0fabb2628199431cf9e2db23e3b04e5cad8

See more details on using hashes here.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page