summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorLorin Hochstein <lorin@nimbisservices.com>2012-05-16 12:02:18 -0400
committerLorin Hochstein <lorin@nimbisservices.com>2012-05-16 12:02:18 -0400
commite1afa4c7cc19054844aee607ccc87d683375a9d8 (patch)
tree421c49ccba03fa3150683fea7e7e96df13acde47 /README.rst
parentd6a27627464a36f86ce63a81c733132231064536 (diff)
downloadpython-openstackclient-e1afa4c7cc19054844aee607ccc87d683375a9d8.tar.gz
Document how to install the client
This documents a workaround for bug 993390. Change-Id: I6d930aa9ad142096cdc2790df4be31f0b1570199
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst14
1 files changed, 10 insertions, 4 deletions
diff --git a/README.rst b/README.rst
index 3a789ec0..ac1e742e 100644
--- a/README.rst
+++ b/README.rst
@@ -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``