From 2b73b75aeba5c60d4622347adb44ce30e20cb4b2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Petr=20=C5=A0pl=C3=ADchal?= <psplicha@redhat.com>
Date: Fri, 30 Nov 2018 15:30:32 +0100
Subject: [PATCH] Update pip installation instructions

---
 docs/install.rst | 35 ++++++++++++++++++++++-------------
 1 file changed, 22 insertions(+), 13 deletions(-)

diff --git a/docs/install.rst b/docs/install.rst
index 08c04811..908ed211 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -29,28 +29,37 @@ __ https://copr.fedoraproject.org/coprs/psss/did/
 PIP
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Basic dependencies for buiding/installing pip packages on Fedora::
+Installing did using pip directly on the system is easy::
 
-    sudo yum install gcc krb5-devel
-    sudo yum install python-devel python-pip python-virtualenv
+    pip install did
 
-Dependencies for Debian-based systems::
+Use virtual environments if you do not want to affect your system.
+Install virtualenv wrapper to make the work more comfortable::
 
-    sudo apt install gcc libkrb5-dev
-    sudo apt install python-dev python-pip python-virtualenv
+    sudo yum install python-virtualenvwrapper   # Fedora
+    sudo apt install virtualenvwrapper          # Ubuntu
 
-Upgrade to the latest pip/setup/virtualenv installer code::
+Create a new virtual environment, upgrade tools, install did::
 
-    sudo pip install --upgrade pip setuptools virtualenv
+    mkvirtualenv did
+    workon did
+    pip install --upgrade pip setuptools
+    pip install did
 
-Install into a python virtual environment (OPTIONAL)::
+This installs the tool and basic requirements. Some of the plugins
+have additional dependencies. Use ``did[plugin]`` to install extra
+dependencies, for example::
 
-    virtualenv ~/did
-    source ~/did/bin/activate
+    pip install did[bugzilla]   # Install bugzilla deps
+    pip install did[docs]       # Get everything for building docs
+    pip install did[tests]      # And for testing
+    pip install did[all]        # Install all extra dependencies
 
-Install did (sudo required if not in a virtualenv)::
+Note: For plugins depending on gssapi (jira & rt) there are some
+extra dependencies::
 
-    pip install did
+    sudo yum install gcc krb5-devel python-devel    # Fedora
+    sudo apt install gcc libkrb5-dev python-dev     # Ubuntu
 
 See the `pypi package index`__ for detailed package information.