From 7511d605e821c201978f07528ee025ecd4a67979 Mon Sep 17 00:00:00 2001 From: Jean-Paul Calderone Date: Wed, 14 Aug 2019 09:27:48 -0400 Subject: [PATCH] Document the use of extras at install time --- docs/INSTALL.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/INSTALL.rst b/docs/INSTALL.rst index f85d5e124..9c7db2c47 100644 --- a/docs/INSTALL.rst +++ b/docs/INSTALL.rst @@ -193,6 +193,17 @@ You can also install directly from the source tarball URL:: tahoe-lafs: 1.13.0 ... +Extras +------ + +Tahoe-LAFS provides some functionality only when explicitly requested at installation time. +It does this using the "extras" feature of setuptools. +You can request these extra features when running the ``pip install`` command like this:: + + % venv/bin/pip install tahoe-lafs[sftp] + +This example enables the SFTP frontend. +The Tahoe-LAFS documentation for specific features which require an explicit install-time step will mention the "extra" that must be requested. Hacking On Tahoe-LAFS ---------------------