Document how to install the client

This documents a workaround for bug 993390.

Change-Id: I6d930aa9ad142096cdc2790df4be31f0b1570199
This commit is contained in:
Lorin Hochstein 2012-05-16 12:02:18 -04:00
parent d6a2762746
commit e1afa4c7cc
1 changed files with 10 additions and 4 deletions

View File

@ -29,11 +29,17 @@ For issue tracking:
Getting Started
===============
Once you have downloaded the client it can be built from setup.py with::
python setup.py install
We recommend using a virtualenv to install the client. This description
uses `virtualenvwrapper`_ to create the virtualenv. Install the prereqs,
then build the egg, and install the client into the virtualenv:
mkvirtualenv openstackclient
pip install -r tools/pip-requires
python setup.py build
easy_install dist/python_openstackclient-0.1-py2.7.egg
.. _virtualenvwrapper: http://www.doughellmann.com/projects/virtualenvwrapper
Alternatively you can build without installing with::
python setup.py build
Toxicity tests can be ran simply by running ``run_tests.sh``