aboutsummaryrefslogtreecommitdiffstats
path: root/docs/faq.rst
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2018-12-07 11:43:38 +0800
committerAlex Gaynor <alex.gaynor@gmail.com>2018-12-06 22:43:38 -0500
commit7e422821b9f800f5345c37011c510dc9e76f552c (patch)
tree684836bedeb4ae9d898a014068f1555cd25c58aa /docs/faq.rst
parentfec719b60441b1e69bcca26446b8025bb69ee1fd (diff)
downloadcryptography-7e422821b9f800f5345c37011c510dc9e76f552c.tar.gz
cryptography-7e422821b9f800f5345c37011c510dc9e76f552c.tar.bz2
cryptography-7e422821b9f800f5345c37011c510dc9e76f552c.zip
remove idna as a primary dependency (#4624)
* remove idna as a primary dependency * empty commit * dynamodb test fix (thanks to Matt Bullock) * review feedback
Diffstat (limited to 'docs/faq.rst')
-rw-r--r--docs/faq.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/faq.rst b/docs/faq.rst
index 409f6ce0..dce94b73 100644
--- a/docs/faq.rst
+++ b/docs/faq.rst
@@ -99,6 +99,18 @@ support multiple versions of Python. The Python 3.4 ``abi3`` wheel can be used
with any version of Python greater than or equal to 3.4. Recent versions of
``pip`` will automatically install ``abi3`` wheels.
+``ImportError``: ``idna`` is not installed
+------------------------------------------
+
+``cryptography`` deprecated passing :term:`U-label` strings to various X.509
+constructors in version 2.1 and in version 2.5 moved the ``idna`` dependency
+to a ``setuptools`` extra. If you see this exception you should upgrade your
+software so that it no longer depends on this deprecated feature. If that is
+not yet possible you can also install ``cryptography`` with
+``pip install cryptography[idna]`` to automatically install the missing
+dependency. This workaround will be available until the feature is fully
+removed.
+
.. _`NaCl`: https://nacl.cr.yp.to/
.. _`PyNaCl`: https://pynacl.readthedocs.io
.. _`WSGIApplicationGroup`: https://modwsgi.readthedocs.io/en/develop/configuration-directives/WSGIApplicationGroup.html