Package: edx-token-utils
token-utilsNoteThis 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.PurposeApp for the creation, signing, and decoding of various access tokensTODO: TheREADME.rstfile should start with a brief description of the repository and its purpose.
It should be described in the context of other repositories under theopenedxorganization. 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 StartedDevelopingOne Time Setup# Clone the repository
git clone git@github.com:openedx/token-utils.git
cd token-utils

# Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
mkvirtualenv -p python3.8 token-utilsEvery time you develop something in this repo# Activate the virtualenv
workon token-utils

# Grab the latest code
git checkout main
git pull

# Install/update the dev requirements
make requirements

# Run the tests and quality checks (to verify the status before you make any changes)
make validate

# Make a new branch for your changes
git checkout -b <your_github_username>/<short_description>

# Using your favorite editor, edit the code to make your change.
vim ...

# Run your new tests
pytest ./path/to/new/tests

# Run all the tests and quality checks
make validate

# Commit all your changes
git commit ...
git push

# Open a PR and ask for review.DeployingTODO: 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 thedeployment how-toGetting HelpDocumentationPLACEHOLDER: Start by going throughthe documentation.  If you need more help see below.(TODO:Set up documentation)More HelpIf you’re having trouble, we have discussion forums athttps://discuss.openedx.orgwhere you can connect with others in the
community.Our real-time conversations are on Slack. You can request aSlack
invitation, then join ourcommunity 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/issuesFor more information about these options, see theGetting Helppage.LicenseThe code in this repository is licensed under the AGPL 3.0 unless
otherwise noted.Please seeLICENSE.txtfor details.ContributingContributions are very welcome.
Please readHow To Contributefor 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 ConductAll community members are expected to follow theOpen edX Code of Conduct.PeopleThe assigned maintainers for this component and other project details may be
found inBackstage. Backstage pulls this data from thecatalog-info.yamlfile in this repo.Reporting Security IssuesPlease do not report security issues in public. Please emailsecurity@tcril.org.Change LogUnreleased[0.2.1] - 2022-12-16AddedFixed changelog formatting error[0.2.0] - 2022-12-15AddedAdded API function to sign access tokenAdded API function to unpack access token[0.1.0] - 2022-08-23AddedFirst release on PyPI.