Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: do not suggest system-wide installation #10

Merged
merged 1 commit into from
Nov 16, 2016
Merged

README: do not suggest system-wide installation #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions README.md
View file
Open in desktop
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