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/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.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.
Raw data
{
"_id": null,
"home_page": "https://github.com/open-craft/learning-credentials",
"name": "learning-credentials",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "Python edx",
"author": "OpenCraft",
"author_email": "help@opencraft.com",
"download_url": "https://files.pythonhosted.org/packages/61/d5/196f895314864bf22c2ce272a4cc074f5830194dce033aaf836794cfe937/learning_credentials-0.2.1.tar.gz",
"platform": null,
"description": "learning-credentials\n####################\n\n|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|\n|license-badge| |status-badge| |visualization-badge|\n\nPurpose\n*******\n\nA pluggable service for preparing Open edX credentials.\n\nThis is focused on the use cases of our client but designed to be a flexible foundation for any Open edX credential\nneeds. It natively supports generating PDF credentials, but can be extended to support other formats.\n\nFor the details about the purpose of this repository, please see the `the following ADR`_.\n\n.. _the following ADR: https://learning-credentials.readthedocs.io/en/latest/decisions/0001-purpose-of-this-repo.html\n\nDocumentation\n*************\n\nStart by going through `the documentation`_.\n\n.. _the documentation: https://learning-credentials.readthedocs.io/en/latest\n\nGetting Help\n************\n\nIf you're having trouble, we have discussion forums at\nhttps://discuss.openedx.org where you can connect with others in the\ncommunity.\n\nOur real-time conversations are on Slack. You can request a `Slack\ninvitation`_, then join our `community Slack workspace`_.\n\nFor anything non-trivial, the best path is to open an issue in this\nrepository with as many details about the issue you are facing as you\ncan provide.\n\nhttps://github.com/open-craft/learning-credentials/issues\n\nFor more information about these options, see the `Getting Help <https://openedx.org/getting-help>`__ page.\n\n.. _Slack invitation: https://openedx.org/slack\n.. _community Slack workspace: https://openedx.slack.com/\n\nLicense\n*******\n\nThe code in this repository is licensed under the AGPL 3.0 unless\notherwise noted.\n\nPlease see `LICENSE.txt <LICENSE.txt>`_ for details.\n\nContributing\n************\n\nContributions are very welcome.\nPlease read `How To Contribute <https://openedx.org/r/how-to-contribute>`_ for details.\n\nThis project is currently accepting all types of contributions, bug fixes,\nsecurity fixes, maintenance work, or new features. However, please make sure\nto have a discussion about your new feature idea with the maintainers prior to\nbeginning development to maximize the chances of your change being accepted.\nYou can start a conversation by creating a new issue on this repo summarizing\nyour idea.\n\nThe Open edX Code of Conduct\n****************************\n\nAll community members are expected to follow the `Open edX Code of Conduct`_.\n\n.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/\n\nPeople\n******\n\n.. TODO: Add the maintainers.\n\nThe assigned maintainers for this component and other project details may be\nfound in `Backstage`_. Backstage pulls this data from the ``catalog-info.yaml``\nfile in this repo.\n\n.. _Backstage: https://backstage.openedx.org/catalog/default/component/learning-credentials\n\nReporting Security Issues\n*************************\n\nPlease do not report security issues in public. Please email security@openedx.org.\n\n.. |pypi-badge| image:: https://img.shields.io/pypi/v/learning-credentials.svg\n :target: https://pypi.python.org/pypi/learning-credentials/\n :alt: PyPI\n\n.. |ci-badge| image:: https://github.com/open-craft/learning-credentials/actions/workflows/ci.yml/badge.svg?branch=main\n :target: https://github.com/open-craft/learning-credentials/actions\n :alt: CI\n\n.. |codecov-badge| image:: https://codecov.io/github/open-craft/learning-credentials/coverage.svg?branch=main\n :target: https://codecov.io/github/open-craft/learning-credentials?branch=main\n :alt: Codecov\n\n.. |doc-badge| image:: https://readthedocs.org/projects/learning-credentials/badge/?version=latest\n :target: https://learning-credentials.readthedocs.io/en/latest\n :alt: Documentation\n\n.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/learning-credentials.svg\n :target: https://pypi.python.org/pypi/learning-credentials/\n :alt: Supported Python versions\n\n.. |license-badge| image:: https://img.shields.io/github/license/open-craft/learning-credentials.svg\n :target: https://github.com/open-craft/learning-credentials/blob/main/LICENSE.txt\n :alt: License\n\n.. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen\n :alt: Status\n\n.. https://githubnext.com/projects/repo-visualization/\n.. |visualization-badge| image:: https://img.shields.io/badge/Repo%20Visualization-8A2BE2\n :target: https://mango-dune-07a8b7110.1.azurestaticapps.net/?repo=open-craft/learning-credentials\n :alt: Visualization\n\n\nChange Log\n##########\n\n..\n All enhancements and patches to learning_credentials will be documented\n in this file. It adheres to the structure of https://keepachangelog.com/ ,\n but in reStructuredText instead of Markdown (for ease of incorporation into\n Sphinx documentation and the PyPI description).\n\n This project adheres to Semantic Versioning (https://semver.org/).\n\n.. There should always be an \"Unreleased\" section for changes pending release.\n\nUnreleased\n**********\n\n*\n\n0.2.1 \u2013 2025-05-05\n******************\n\nFixed\n=====\n\n* Check enrollment status before issuing Learning Path credentials.\n\n0.2.0 \u2013 2025-04-03\n******************\n\nAdded\n=====\n\n* Learning Paths support.\n\n\n0.1.0 \u2013 2025-01-29\n******************\n\nAdded\n=====\n\n* Initial implementation of the certificates app.\n",
"bugtrack_url": null,
"license": "AGPL 3.0",
"summary": "A pluggable service for preparing Open edX credentials.",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/open-craft/learning-credentials"
},
"split_keywords": [
"python",
"edx"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c353e9a9eb8c44c058cdadb522f4006e108ded8bdfd75f6b5e4c62195a028f8f",
"md5": "5a8db72072070355168410a84374f478",
"sha256": "05fa0fa9baecbd0eeedc6687d51eaf329372648f0c2b102a08990774d2fb9d27"
},
"downloads": -1,
"filename": "learning_credentials-0.2.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "5a8db72072070355168410a84374f478",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.11",
"size": 47771,
"upload_time": "2025-05-05T13:19:24",
"upload_time_iso_8601": "2025-05-05T13:19:24.908470Z",
"url": "https://files.pythonhosted.org/packages/c3/53/e9a9eb8c44c058cdadb522f4006e108ded8bdfd75f6b5e4c62195a028f8f/learning_credentials-0.2.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "61d5196f895314864bf22c2ce272a4cc074f5830194dce033aaf836794cfe937",
"md5": "1dfe2def8d19687eef06f59a83e7a8d7",
"sha256": "287272df5f083ca5be53b204b984e1669e49360f5bbefe15064a0967d15d347d"
},
"downloads": -1,
"filename": "learning_credentials-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "1dfe2def8d19687eef06f59a83e7a8d7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 54301,
"upload_time": "2025-05-05T13:19:26",
"upload_time_iso_8601": "2025-05-05T13:19:26.951000Z",
"url": "https://files.pythonhosted.org/packages/61/d5/196f895314864bf22c2ce272a4cc074f5830194dce033aaf836794cfe937/learning_credentials-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-05-05 13:19:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "open-craft",
"github_project": "learning-credentials",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "learning-credentials"
}
JSON
