123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113 |
- Metadata-Version: 2.1
- Name: Flask-JWT-Extended
- Version: 4.4.1
- Summary: Extended JWT integration with Flask
- Home-page: https://github.com/vimalloc/flask-jwt-extended
- Author: Lily Acadia Gilbert
- Author-email: lily.gilbert@hey.com
- License: MIT
- Keywords: flask,jwt,json web token
- Platform: any
- Classifier: Development Status :: 5 - Production/Stable
- Classifier: Environment :: Web Environment
- Classifier: Framework :: Flask
- Classifier: Intended Audience :: Developers
- Classifier: License :: OSI Approved :: MIT License
- Classifier: Operating System :: OS Independent
- Classifier: Programming Language :: Python
- Classifier: Programming Language :: Python :: 3
- Classifier: Programming Language :: Python :: 3 :: Only
- Classifier: Programming Language :: Python :: 3.6
- Classifier: Programming Language :: Python :: 3.7
- Classifier: Programming Language :: Python :: 3.8
- Classifier: Programming Language :: Python :: 3.9
- Classifier: Programming Language :: Python :: Implementation :: CPython
- Classifier: Programming Language :: Python :: Implementation :: PyPy
- Classifier: Topic :: Software Development :: Libraries :: Python Modules
- Requires-Python: >=3.6,<4
- Description-Content-Type: text/markdown
- License-File: LICENSE
- Requires-Dist: Werkzeug (>=0.14)
- Requires-Dist: Flask (<3.0,>=2.0)
- Requires-Dist: PyJWT (<3.0,>=2.0)
- Requires-Dist: typing-extensions (>=3.7.4) ; python_version < "3.8"
- Provides-Extra: asymmetric_crypto
- Requires-Dist: cryptography (>=3.3.1) ; extra == 'asymmetric_crypto'
- # Flask-JWT-Extended
- ### Features
- Flask-JWT-Extended not only adds support for using JSON Web Tokens (JWT) to Flask for protecting routes,
- but also many helpful (and **optional**) features built in to make working with JSON Web Tokens
- easier. These include:
- - Adding custom claims to JSON Web Tokens
- - Automatic user loading (`current_user`).
- - Custom claims validation on received tokens
- - [Refresh tokens](https://auth0.com/blog/refresh-tokens-what-are-they-and-when-to-use-them/)
- - First class support for fresh tokens for making sensitive changes.
- - Token revoking/blocklisting
- - Storing tokens in cookies and CSRF protection
- ### Usage
- [View the documentation online](https://flask-jwt-extended.readthedocs.io/en/stable/)
- ### Upgrading from 3.x.x to 4.0.0
- [View the changes](https://flask-jwt-extended.readthedocs.io/en/stable/v4_upgrade_guide/)
- ### Changelog
- You can view the changelog [here](https://github.com/vimalloc/flask-jwt-extended/releases).
- This project follows [semantic versioning](https://semver.org/).
- ### Chatting
- Come chat with the community or ask questions at https://discord.gg/EJBsbFd
- ### Contributing
- Before making any changes, make sure to install the development requirements
- and setup the git hooks which will automatically lint and format your changes.
- ```bash
- pip install -r requirements.txt
- pre-commit install
- ```
- We require 100% code coverage in our unit tests. You can run the tests locally
- with `tox` which ensures that all tests pass, tests provide complete code coverage,
- documentation builds, and style guide are adhered to
- ```bash
- tox
- ```
- A subset of checks can also be ran by adding an argument to tox. The available
- arguments are:
- - py36, py37, py38, py39, py310, pypy3
- - Run unit tests on the given python version
- - mypy
- - Run mypy type checking
- - coverage
- - Run a code coverage check
- - docs
- - Ensure documentation builds and there are no broken links
- - style
- - Ensure style guide is adhered to
- ```bash
- tox -e py38
- ```
- We also require features to be well documented. You can generate a local copy
- of the documentation by going to the `docs` directory and running:
- ```bash
- make clean && make html && open _build/html/index.html
- ```
|