diff options
Diffstat (limited to 'docs/installation.rst')
| -rw-r--r-- | docs/installation.rst | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/installation.rst b/docs/installation.rst new file mode 100644 index 0000000..e6608b6 --- /dev/null +++ b/docs/installation.rst @@ -0,0 +1,37 @@ +============================= +Installation and Requirements +============================= + + +Installation +============ + +``$ pip install service_identity`` + + +Requirements +============ + +Python 2.7, 3.4 and later, as well as PyPy are supported. + +Additionally, the following PyPI modules are required: + +- attrs_ +- pyOpenSSL_ ``>= 0.14`` (``0.12`` and ``0.13`` may work but are not part of CI anymore) +- pyasn1_ +- pyasn1-modules_ + +Optionally, idna_ ``>= 0.6`` can be used for `internationalized domain names`_ (IDN), i.e. non-ASCII domains. +Unfortunately it’s required because Python’s IDN support in the standard library is outdated_ even in the latest releases. + +If you need Python 3.2 support, you will have to use the latest 0.2.x release. +If you need Python 2.6 or 3.3 support, you will have to use the latest 14.0.x release. +They will receive bug fix releases if necessary but other than that no further development is planned. + +.. _attrs: https://attrs.readthedocs.org/ +.. _pyOpenSSL: https://pypi.python.org/pypi/pyOpenSSL/ +.. _pyasn1-modules: https://pypi.python.org/pypi/pyasn1-modules/ +.. _pyasn1: https://pypi.python.org/pypi/pyasn1/ +.. _`internationalized domain names`: https://en.wikipedia.org/wiki/Internationalized_domain_name +.. _idna: https://pypi.python.org/pypi/idna/ +.. _outdated: https://bugs.python.org/issue17305 |