summaryrefslogtreecommitdiff
path: root/docs/installation.rst
blob: 6da2ccdfcaffc21998bf29171dbc815a3e801a55 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
Installation
============

You can install ``PyJWT`` with ``pip``:

.. code-block:: console

    $ pip install pyjwt

Cryptographic Dependencies (Optional)
-------------------------------------

If you are planning on encoding or decoding tokens using certain digital
signature algorithms (like RSA or ECDSA), you will need to install the
cryptography_ library. This can be installed explicitly, or as a required
extra in the ``pyjwt`` requirement:

.. code-block:: console

    $ pip install pyjwt[crypto]

The ``pyjwt[crypto]`` format is recommended in requirements files in
projects using ``PyJWT``, as a separate ``cryptography`` requirement line
may later be mistaken for an unused requirement and removed.


.. _`cryptography`: https://cryptography.io