diff options
| author | Jeff Forcier <jeff@bitprophet.org> | 2019-10-08 11:29:38 -0400 |
|---|---|---|
| committer | Jeff Forcier <jeff@bitprophet.org> | 2019-12-02 14:59:49 -0500 |
| commit | 4a95e1f88b0996c937c98d31c94a51a450984019 (patch) | |
| tree | c03b010dfc472e3a5c86b5b3ad3e94bf23733c15 /sites | |
| parent | c9c60433a2fc50088cebddabc5055524c8ebe959 (diff) | |
Add additional setuptools extras_require flavors
Diffstat (limited to 'sites')
| -rw-r--r-- | sites/www/changelog.rst | 3 | ||||
| -rw-r--r-- | sites/www/installing.rst | 24 |
2 files changed, 23 insertions, 4 deletions
diff --git a/sites/www/changelog.rst b/sites/www/changelog.rst index 91c10eeb..23e9a567 100644 --- a/sites/www/changelog.rst +++ b/sites/www/changelog.rst @@ -2,6 +2,9 @@ Changelog ========= +- :support:`-` Additional :doc:`installation </installing>` ``extras_require`` + "flavors" (``ed25519`` and ``everything``) have been added to our packaging + metadata; see the install docs for details. - :bug:`- major` Paramiko's use of ``subprocess`` for ``ProxyCommand`` support is conditionally imported to prevent issues on limited interpreter platforms like Google Compute Engine. However, any resulting ``ImportError`` was lost diff --git a/sites/www/installing.rst b/sites/www/installing.rst index cffdba5f..26637e16 100644 --- a/sites/www/installing.rst +++ b/sites/www/installing.rst @@ -22,15 +22,28 @@ via `pip <http://pip-installer.org>`_:: We currently support **Python 2.7, 3.4+, and PyPy**. Users on Python 2.6 or older (or 3.3 or older) are urged to upgrade. -Paramiko has only a few direct dependencies: +Paramiko has only a few **direct dependencies**: - The big one, with its own sub-dependencies, is Cryptography; see :ref:`its - specific note below <cryptography>` for more details. + specific note below <cryptography>` for more details; - `bcrypt <https://pypi.org/project/bcrypt/>`_, for Ed25519 key support; - `pynacl <https://pypi.org/project/PyNaCl/>`_, also for Ed25519 key support. -If you need GSS-API / SSPI support, see :ref:`the below subsection on it -<gssapi>` for details on its optional dependencies. +There are also a number of **optional dependencies** you may install using +`setuptools 'extras' +<https://packaging.python.org/tutorials/installing-packages/#installing-setuptools-extras>`_: + +.. TODO 3.0: tweak the ed25519 line to remove the caveat + +- If you want all optional dependencies at once, use ``paramiko[everything]``. +- For GSS-API / SSPI support, use ``paramiko[gssapi]``, though also see + :ref:`the below subsection on it <gssapi>` for details. +- ``paramiko[ed25519]`` references the dependencies for Ed25519 key support. + + - As of Paramiko 2.x this doesn't technically do anything, as those + dependencies are core installation requirements. + - However, you should use this for forwards compatibility; 3.0 will drop + those dependencies from core, leaving them purely optional. .. _release-lines: @@ -116,6 +129,9 @@ optional Python package requirements by changing your installation to refer to (Or update your ``requirements.txt``, or etc.) + +.. TODO: just axe this once legacy gssapi support is gone, no point reiterating + Manual dependency installation ------------------------------ |