METADATA 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. Metadata-Version: 2.1
  2. Name: Flask-JWT-Extended
  3. Version: 4.4.1
  4. Summary: Extended JWT integration with Flask
  5. Home-page: https://github.com/vimalloc/flask-jwt-extended
  6. Author: Lily Acadia Gilbert
  7. Author-email: lily.gilbert@hey.com
  8. License: MIT
  9. Keywords: flask,jwt,json web token
  10. Platform: any
  11. Classifier: Development Status :: 5 - Production/Stable
  12. Classifier: Environment :: Web Environment
  13. Classifier: Framework :: Flask
  14. Classifier: Intended Audience :: Developers
  15. Classifier: License :: OSI Approved :: MIT License
  16. Classifier: Operating System :: OS Independent
  17. Classifier: Programming Language :: Python
  18. Classifier: Programming Language :: Python :: 3
  19. Classifier: Programming Language :: Python :: 3 :: Only
  20. Classifier: Programming Language :: Python :: 3.6
  21. Classifier: Programming Language :: Python :: 3.7
  22. Classifier: Programming Language :: Python :: 3.8
  23. Classifier: Programming Language :: Python :: 3.9
  24. Classifier: Programming Language :: Python :: Implementation :: CPython
  25. Classifier: Programming Language :: Python :: Implementation :: PyPy
  26. Classifier: Topic :: Software Development :: Libraries :: Python Modules
  27. Requires-Python: >=3.6,<4
  28. Description-Content-Type: text/markdown
  29. License-File: LICENSE
  30. Requires-Dist: Werkzeug (>=0.14)
  31. Requires-Dist: Flask (<3.0,>=2.0)
  32. Requires-Dist: PyJWT (<3.0,>=2.0)
  33. Requires-Dist: typing-extensions (>=3.7.4) ; python_version < "3.8"
  34. Provides-Extra: asymmetric_crypto
  35. Requires-Dist: cryptography (>=3.3.1) ; extra == 'asymmetric_crypto'
  36. # Flask-JWT-Extended
  37. ### Features
  38. Flask-JWT-Extended not only adds support for using JSON Web Tokens (JWT) to Flask for protecting routes,
  39. but also many helpful (and **optional**) features built in to make working with JSON Web Tokens
  40. easier. These include:
  41. - Adding custom claims to JSON Web Tokens
  42. - Automatic user loading (`current_user`).
  43. - Custom claims validation on received tokens
  44. - [Refresh tokens](https://auth0.com/blog/refresh-tokens-what-are-they-and-when-to-use-them/)
  45. - First class support for fresh tokens for making sensitive changes.
  46. - Token revoking/blocklisting
  47. - Storing tokens in cookies and CSRF protection
  48. ### Usage
  49. [View the documentation online](https://flask-jwt-extended.readthedocs.io/en/stable/)
  50. ### Upgrading from 3.x.x to 4.0.0
  51. [View the changes](https://flask-jwt-extended.readthedocs.io/en/stable/v4_upgrade_guide/)
  52. ### Changelog
  53. You can view the changelog [here](https://github.com/vimalloc/flask-jwt-extended/releases).
  54. This project follows [semantic versioning](https://semver.org/).
  55. ### Chatting
  56. Come chat with the community or ask questions at https://discord.gg/EJBsbFd
  57. ### Contributing
  58. Before making any changes, make sure to install the development requirements
  59. and setup the git hooks which will automatically lint and format your changes.
  60. ```bash
  61. pip install -r requirements.txt
  62. pre-commit install
  63. ```
  64. We require 100% code coverage in our unit tests. You can run the tests locally
  65. with `tox` which ensures that all tests pass, tests provide complete code coverage,
  66. documentation builds, and style guide are adhered to
  67. ```bash
  68. tox
  69. ```
  70. A subset of checks can also be ran by adding an argument to tox. The available
  71. arguments are:
  72. - py36, py37, py38, py39, py310, pypy3
  73. - Run unit tests on the given python version
  74. - mypy
  75. - Run mypy type checking
  76. - coverage
  77. - Run a code coverage check
  78. - docs
  79. - Ensure documentation builds and there are no broken links
  80. - style
  81. - Ensure style guide is adhered to
  82. ```bash
  83. tox -e py38
  84. ```
  85. We also require features to be well documented. You can generate a local copy
  86. of the documentation by going to the `docs` directory and running:
  87. ```bash
  88. make clean && make html && open _build/html/index.html
  89. ```