Skip to content

Commit

Permalink
README: do not suggest system-wide installation
Browse files Browse the repository at this point in the history
A better solution is to use user-specific installations or putting
ipa-docker-test-runner into virtual environment.

https://github.com/martbab/ipa-docker-test-runner/issues/6
  • Loading branch information
Martin Babinsky authored and martbab committed Nov 16, 2016
1 parent 0dc8033 commit 70d2f01
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,25 @@ production-ready images with FreeIPA server and SSSD client.
Installation
------------

You need to have python3 install along with PyYAML and docker-py packages.
You need to have python3 installed along with PyYAML and docker-py packages.
If you wish to run the included tests you need to have pytest installed as
well.

Clone the git repo and run:
The safest way is to clone the git repo and install the package into clean
Python root using virtualenv:

sudo python3 setup.py install
$ python3 -m venv venv
$ venv/bin/pip install .
$ venv/bin/ipa-docker-test-runner

You can also use pip to install `ipa-docker-test-runner` directly from github:

pip3 install git+https://github.com/martbab/ipa-docker-test-runner
pip3 install --user git+https://github.com/martbab/ipa-docker-test-runner

To install it only for you local user, pass `--user` option to pip. After
installation you should have `ipa-docker-test-runner` script in your $PATH.
It is preferrable to install ipa-docker-test-runner into the local user's
PYTHONPATH in order to avoid clashes with the packages installed system-wide.
After installation you should have `ipa-docker-test-runner` script in your
$PATH.

Configuration
-------------
Expand Down

0 comments on commit 70d2f01

Please sign in to comment.