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

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.3.1rc2.tar.gz (58.8 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.3.1rc2-py3-none-any.whl (51.6 kB view details)

Uploaded Python 3

File details

Details for the file learning_credentials-0.3.1rc2.tar.gz.

File metadata

  • Download URL: learning_credentials-0.3.1rc2.tar.gz
  • Upload date:
  • Size: 58.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","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.3.1rc2.tar.gz
Algorithm Hash digest
SHA256 7f8bec63d9e05d17fc049a23ff1f7e12e901285b9109a5328dfed438ff4810fe
MD5 298d66136951e12675d6fc32693cd9b7
BLAKE2b-256 a66345e83714ddfc3d4942b73996fa0aa8dbccdbf2b78a9762683a9776fdb5d0

See more details on using hashes here.

File details

Details for the file learning_credentials-0.3.1rc2-py3-none-any.whl.

File metadata

  • Download URL: learning_credentials-0.3.1rc2-py3-none-any.whl
  • Upload date:
  • Size: 51.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","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.3.1rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 ff10ecb941702c647b4665c999e4e132b62c4e5814e8aaab9e06c7af09e627ed
MD5 f059995a5ac9583e377a65acc83f5dc3
BLAKE2b-256 c7f8e8786501003157b5187c7d44d3744f2dac3f80ce976abd914e5adf2cb1ec

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