METADATA 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150
  1. Metadata-Version: 2.1
  2. Name: python-jose
  3. Version: 3.4.0
  4. Summary: JOSE implementation in Python
  5. Home-page: http://github.com/mpdavis/python-jose
  6. Author: Michael Davis
  7. Author-email: mike.philip.davis@gmail.com
  8. License: MIT
  9. Project-URL: Documentation, https://python-jose.readthedocs.io/en/latest/
  10. Project-URL: Source, https://github.com/mpdavis/python-jose/
  11. Project-URL: Tracker, https://github.com/mpdavis/python-jose/issues/
  12. Project-URL: Changelog, https://github.com/mpdavis/python-jose/blob/master/CHANGELOG.md
  13. Keywords: jose jws jwe jwt json web token security signing
  14. Platform: UNKNOWN
  15. Classifier: Development Status :: 5 - Production/Stable
  16. Classifier: Intended Audience :: Developers
  17. Classifier: Natural Language :: English
  18. Classifier: License :: OSI Approved :: MIT License
  19. Classifier: Programming Language :: Python
  20. Classifier: Programming Language :: Python :: 3
  21. Classifier: Programming Language :: Python :: 3 :: Only
  22. Classifier: Programming Language :: Python :: 3.7
  23. Classifier: Programming Language :: Python :: 3.8
  24. Classifier: Programming Language :: Python :: 3.9
  25. Classifier: Programming Language :: Python :: 3.10
  26. Classifier: Programming Language :: Python :: 3.11
  27. Classifier: Programming Language :: Python :: Implementation :: PyPy
  28. Classifier: Topic :: Utilities
  29. License-File: LICENSE
  30. Requires-Dist: ecdsa!=0.15
  31. Requires-Dist: rsa!=4.1.1,!=4.4,<5.0,>=4.0
  32. Requires-Dist: pyasn1<0.5.0,>=0.4.1
  33. Provides-Extra: cryptography
  34. Requires-Dist: cryptography>=3.4.0; extra == "cryptography"
  35. Provides-Extra: pycrypto
  36. Requires-Dist: pycrypto<2.7.0,>=2.6.0; extra == "pycrypto"
  37. Provides-Extra: pycryptodome
  38. Requires-Dist: pycryptodome<4.0.0,>=3.3.1; extra == "pycryptodome"
  39. Provides-Extra: test
  40. Requires-Dist: pytest; extra == "test"
  41. Requires-Dist: pytest-cov; extra == "test"
  42. python-jose
  43. ===========
  44. A JOSE implementation in Python
  45. |pypi| |Github Actions CI Status| |Coverage Status| |Docs| |style|
  46. Docs are available on ReadTheDocs_.
  47. The JavaScript Object Signing and Encryption (JOSE) technologies - JSON
  48. Web Signature (JWS), JSON Web Encryption (JWE), JSON Web Key (JWK), and
  49. JSON Web Algorithms (JWA) - collectively can be used to encrypt and/or
  50. sign content using a variety of algorithms. While the full set of
  51. permutations is extremely large, and might be daunting to some, it is
  52. expected that most applications will only use a small set of algorithms
  53. to meet their needs.
  54. Installation
  55. ------------
  56. ::
  57. $ pip install python-jose[cryptography]
  58. Cryptographic Backends
  59. ----------------------
  60. As of 3.3.0, python-jose implements three different cryptographic backends.
  61. The backend must be selected as an extra when installing python-jose.
  62. If you do not select a backend, the native-python backend will be installed.
  63. Unless otherwise noted, all backends support all operations.
  64. Due to complexities with setuptools, the native-python backend is always installed,
  65. even if you select a different backend on install.
  66. We recommend that you remove unnecessary dependencies in production.
  67. #. cryptography
  68. * This backend uses `pyca/cryptography`_ for all cryptographic operations.
  69. This is the recommended backend and is selected over all other backends if any others are present.
  70. * Installation: ``pip install python-jose[cryptography]``
  71. * Unused dependencies:
  72. * ``rsa``
  73. * ``ecdsa``
  74. * ``pyasn1``
  75. #. pycryptodome
  76. * This backend uses `pycryptodome`_ for all cryptographic operations.
  77. * Installation: ``pip install python-jose[pycryptodome]``
  78. * Unused dependencies:
  79. * ``rsa``
  80. #. native-python
  81. * This backend uses `python-rsa`_ and `python-ecdsa`_ for all cryptographic operations.
  82. This backend is always installed but any other backend will take precedence if one is installed.
  83. * Installation: ``pip install python-jose``
  84. .. note::
  85. The native-python backend cannot process certificates.
  86. Usage
  87. -----
  88. .. code-block:: python
  89. >>> from jose import jwt
  90. >>> token = jwt.encode({'key': 'value'}, 'secret', algorithm='HS256')
  91. u'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJ2YWx1ZSJ9.FG-8UppwHaFp1LgRYQQeS6EDQF7_6-bMFegNucHjmWg'
  92. >>> jwt.decode(token, 'secret', algorithms=['HS256'])
  93. {u'key': u'value'}
  94. Thanks
  95. ------
  96. This library was originally based heavily on the work of the folks over at PyJWT_.
  97. .. |pypi| image:: https://img.shields.io/pypi/v/python-jose?style=flat-square
  98. :target: https://pypi.org/project/python-jose/
  99. :alt: PyPI
  100. .. |Github Actions CI Status| image:: https://github.com/mpdavis/python-jose/workflows/main/badge.svg?branch=master
  101. :target: https://github.com/mpdavis/python-jose/actions?workflow=main
  102. :alt: Github Actions CI Status
  103. .. |Coverage Status| image:: http://codecov.io/github/mpdavis/python-jose/coverage.svg?branch=master
  104. :target: http://codecov.io/github/mpdavis/python-jose?branch=master
  105. .. |Docs| image:: https://readthedocs.org/projects/python-jose/badge/
  106. :target: https://python-jose.readthedocs.org/en/latest/
  107. .. _ReadTheDocs: https://python-jose.readthedocs.org/en/latest/
  108. .. _PyJWT: https://github.com/jpadilla/pyjwt
  109. .. _pyca/cryptography: http://cryptography.io/
  110. .. _pycryptodome: https://pycryptodome.readthedocs.io/en/latest/
  111. .. _pycrypto: https://www.dlitz.net/software/pycrypto/
  112. .. _python-ecdsa: https://github.com/warner/python-ecdsa
  113. .. _python-rsa: https://stuvel.eu/rsa
  114. .. |style| image:: https://img.shields.io/badge/code%20style-black-000000.svg
  115. :target: https://github.com/psf/black
  116. :alt: Code style: black