Skip to content

Commit

Permalink
Update pip installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
psss committed Nov 30, 2018
1 parent ed7f2f1 commit 2b73b75
Showing 1 changed file with 22 additions and 13 deletions.
35 changes: 22 additions & 13 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 2b73b75

Please # to comment.