diff options
Diffstat (limited to 'docs/install.rst')
| -rw-r--r-- | docs/install.rst | 47 |
1 files changed, 19 insertions, 28 deletions
diff --git a/docs/install.rst b/docs/install.rst index 2ebe119..f48af45 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -6,27 +6,28 @@ Installation Supported Platforms =================== -Passlib requires Python 2 (>= 2.6) or Python 3 (>= 3.3). +Passlib requires Python 3.5 or newer. It is known to work with the following Python implementations: .. rst-class:: float-right without-title .. warning:: - **Passlib 1.8 will drop support for Python 2.x, 3.3, and 3.4**; - and will require Python >= 3.5. The 1.7 series will be the - last to support Python 2. (See :issue:`119` for rationale). + **Passlib 1.8 dropped support for Python 2.x, 3.3, and 3.4**; + If you need support for Python 2.6 - 3.4, use the Passlib 1.7.x series. -* CPython 2 -- v2.6 or newer. -* CPython 3 -- v3.3 or newer. -* PyPy -- v2.0 or newer. +* CPython 3 -- v3.5 or newer. * PyPy3 -- v5.3 or newer. -* Jython -- v2.7 or newer. Passlib should work with all operating systems and environments, as it contains builtin fallbacks for almost all OS-dependant features. Google App Engine is supported as well. +.. versionchanged:: 1.8 + + Support for Python 2.x, 3.3, and 3.4 was dropped. + Jython no longer listed, until it has a Python 3 compatible for testing. + .. versionchanged:: 1.7 Support for Python 2.5, 3.0-3.2 was dropped. @@ -36,25 +37,12 @@ Google App Engine is supported as well. Optional Libraries ================== -* `bcrypt <https://pypi.python.org/pypi/bcrypt>`_, - `py-bcrypt <https://pypi.python.org/pypi/py-bcrypt>`_, or - `bcryptor <https://bitbucket.org/ares/bcryptor/overview>`_ - - .. rst-class:: float-right +* `bcrypt <https://pypi.python.org/pypi/bcrypt>`_ - .. warning:: - - Support for ``py-bcrypt`` and ``bcryptor`` will be dropped in Passlib 1.8, - as these libraries are unmaintained. - - If any of these packages are installed, they will be used to provide - support for the BCrypt hash algorithm. - This is required if you want to handle BCrypt hashes, - and your OS does not provide native BCrypt support - via stdlib's :mod:`!crypt` (which includes pretty much all non-BSD systems). - - `bcrypt <https://pypi.python.org/pypi/bcrypt>`_ is currently the recommended - option -- it's actively maintained, and compatible with both CPython and PyPy. + If installed, this will be used to handle :class:~passlib.hash.bcrypt` and + :class:`~passlib.hash.bcrypt_sha256` hashes. If your system lacks :func:`crypt.crypt()` + support for bcrypt hashes, this library is *required* in order for passlib to provide + bcrypt support. Use ``pip install passlib[bcrypt]`` to get the recommended bcrypt setup. @@ -85,6 +73,10 @@ Optional Libraries If installed, this will be used to provide support for the :class:`~passlib.hash.scrypt` hash algorithm. If not installed, a MUCH slower builtin reference implementation will be used. +.. versionchanged:: 1.8 + + Dropped support for ``py-bcrypt`` and ``bcryptor`` backends. + .. versionchanged:: 1.7 Added fastpbkdf2, cryptography, argon2_cffi, argon2pure, and scrypt support. @@ -129,8 +121,7 @@ algorithms using multiple external sources (if detected at runtime). All unit tests are contained within the :mod:`passlib.tests` subpackage, and are designed to be run using the -`Nose <http://somethingaboutorange.com/mrl/projects/nose>`_ unit testing library -(as well as the ``unittest2`` library under Python 2.6). +`Nose <http://somethingaboutorange.com/mrl/projects/nose>`_ unit testing library. Once Passlib and Nose have been installed, the main suite of tests may be run using:: |