Skip to main content

A pluggable service for preparing Open edX credentials.

Project description

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.4.0 - 2025-11-03

Added

  • Frontend form and backend API endpoint for verifying credentials.

  • Option to invalidate issued credentials.

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.

Project details


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.4.0rc1.tar.gz (59.6 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.4.0rc1-py3-none-any.whl (54.9 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for learning_credentials-0.4.0rc1.tar.gz
Algorithm Hash digest
SHA256 15c32a9d41a3ea480ece4188830a686a76692f49718995b3d04a88e133d4f07f
MD5 d71636ef87526bac336c33f320eecda6
BLAKE2b-256 a13e08cd82cd53cfd115e6bdeb5b3ba495eddb0a2f73a4fe5dde4860efad7a90

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for learning_credentials-0.4.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 f7511963c63ff66e36ce54ba41df0ba9d49ed3239cf661448c81abddacafda1f
MD5 c1bc985c9674055dce817845a45fcddf
BLAKE2b-256 b96911ba4c56f2b07f87fa8f475f8bca7060318c15a7e521a3a3b476e6e43e74

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page