token-utils #############################
.. note::
This README was auto-generated. Maintainer: please review its contents and update all relevant sections. Instructions to you are marked with "PLACEHOLDER" or "TODO". Update or remove those sections, and remove this note when you are done.
|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge| |license-badge| |status-badge|
Purpose
App for the creation, signing, and decoding of various access tokens
TODO: The README.rst file should start with a brief description of the repository and its purpose.
It should be described in the context of other repositories under the openedx
organization. It should make clear where this fits in to the overall Open edX
codebase and should be oriented towards people who are new to the Open edX
project.
Getting Started
.. code-block::
git clone git@github.com:openedx/token-utils.git cd token-utils
mkvirtualenv -p python3.8 token-utils
.. code-block::
workon token-utils
git checkout main git pull
make requirements
make validate
git checkout -b <your_github_username>/<short_description>
vim ...
pytest ./path/to/new/tests
make validate
git commit ... git push
TODO: How can a new user go about deploying this component? Is it just a few commands? Is there a larger how-to that should be linked here?
PLACEHOLDER: For details on how to deploy this component, see the deployment how-to_
.. _deployment how-to: https://docs.openedx.org/projects/token-utils/how-tos/how-to-deploy-this-component.html
Getting Help
PLACEHOLDER: Start by going through the documentation_. If you need more help see below.
.. _the documentation: https://docs.openedx.org/projects/token-utils
(TODO: Set up documentation <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>_)
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/openedx/token-utils/issues
For more information about these options, see the Getting Help_ page.
.. _Slack invitation: https://openedx.org/slack .. _community Slack workspace: https://openedx.slack.com/ .. _Getting Help: https://openedx.org/getting-help
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
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://open-edx-backstage.herokuapp.com/catalog/default/component/token-utils
Reporting Security Issues
Please do not report security issues in public. Please email security@tcril.org.
.. |pypi-badge| image:: https://img.shields.io/pypi/v/token-utils.svg :target: https://pypi.python.org/pypi/token-utils/ :alt: PyPI
.. |ci-badge| image:: https://github.com/openedx/token-utils/workflows/Python%20CI/badge.svg?branch=main :target: https://github.com/openedx/token-utils/actions :alt: CI
.. |codecov-badge| image:: https://codecov.io/github/openedx/token-utils/coverage.svg?branch=main :target: https://codecov.io/github/openedx/token-utils?branch=main :alt: Codecov
.. |doc-badge| image:: https://readthedocs.org/projects/token-utils/badge/?version=latest :target: https://token-utils.readthedocs.io/en/latest/ :alt: Documentation
.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/token-utils.svg :target: https://pypi.python.org/pypi/token-utils/ :alt: Supported Python versions
.. |license-badge| image:: https://img.shields.io/github/license/openedx/token-utils.svg :target: https://github.com/openedx/token-utils/blob/main/LICENSE.txt :alt: License
.. TODO: Choose one of the statuses below and remove the other status-badge lines. .. |status-badge| image:: https://img.shields.io/badge/Status-Experimental-yellow .. .. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen .. .. |status-badge| image:: https://img.shields.io/badge/Status-Deprecated-orange .. .. |status-badge| image:: https://img.shields.io/badge/Status-Unsupported-red
Change Log ##########
.. All enhancements and patches to token_utils 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] - 2022-12-16
[0.2.0] - 2022-12-15
[0.1.0] - 2022-08-23
FAQs
App for the creation, signing, and decoding of various access tokens
We found that edx-token-utils demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
