index.rst

Welcome to PyJWT

PyJWT is a Python library which allows you to encode and decode JSON Web Tokens (JWT). JWT is an open, industry-standard (RFC 7519) for representing claims securely between two parties.

Sponsor

If you want to quickly add secure token-based authentication to Python projects, feel free to check Auth0's Python SDK and free plan at auth0.com/overview.

Installation

You can install pyjwt with pip:

$ pip install pyjwt

See :doc:`Installation <installation>` for more information.

Example Usage

>>> import jwt

>>> encoded_jwt = jwt.encode({'some': 'payload'}, 'secret', algorithm='HS256')
>>> encoded_jwt
'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzb21lIjoicGF5bG9hZCJ9.4twFt5NiznN84AWoo1d7KO1T_yoc0Z6XOpOVswacPZg'

>>> jwt.decode(encoded_jwt, 'secret', algorithms=['HS256'])
{'some': 'payload'}

See :doc:`Usage Examples <usage>` for more examples.

Command line

Usage:

pyjwt [options] INPUT

Decoding examples:

pyjwt --key=secret TOKEN
pyjwt --no-verify TOKEN

See more options executing pyjwt --help.

Index

.. toctree::
    :maxdepth: 2

    installation
    usage
    faq
    algorithms
    api