summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGunnlaugur Thor Briem <gunnlaugur@gmail.com>2019-06-12 13:24:33 +0000
committerJosé Padilla <jpadilla@webapplicate.com>2019-06-12 09:24:33 -0400
commit3d47b0ea9e5d489f9c90ee6dde9e3d9d69244e3a (patch)
treecacb4b31520037ccb066534824b42c279f6123d4
parent2c8bfe502a5fc3803e6334c4914016bfa805f181 (diff)
downloadpyjwt-3d47b0ea9e5d489f9c90ee6dde9e3d9d69244e3a.tar.gz
Document (and prefer) `pyjwt[crypto]` req format (#426)
-rw-r--r--docs/installation.rst9
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/installation.rst b/docs/installation.rst
index a10cddd..7e9c220 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -12,11 +12,16 @@ 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.
+cryptography_ library. This can be installed explicitly, or as a required
+extra in the ``pyjwt`` requirement:
.. code-block:: console
- $ pip install cryptography
+ $ 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.
.. _legacy-deps: