diff --git a/doc/conf.py b/doc/conf.py index 772c340..35da40c 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -228,7 +228,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'lbaas', u'LBaaS Client', - [u'Andrew Hutchings'], 1) -] +#man_pages = [ +# ('index', 'lbaas', u'LBaaS Client', +# [u'Andrew Hutchings'], 1) +#] diff --git a/doc/installation.rst b/doc/installation.rst index c974cba..12562d3 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -1,28 +1,87 @@ +.. _installation: + Installation ============ -From Ubuntu Package -------------------- +.. _install-ppa: -.. code-block:: bash +From Ubuntu Package via PPA +--------------------------- - sudo apt-get install python-pip - sudo pip install python-novaclient --upgrade - sudo dpkg -i python-libraclient_1.2.2-1_all.deb +1. Install utility -If the last command fails with an unmet dependency run this to fix it: +:: -.. code-block:: bash + sudo apt-get install python-software-properties - sudo apt-get -fy install +2. Add the PPA -From Source ------------ +:: -The python-setuptools package needs to be installed on your system before -installing the client from source. + sudo apt-add-repository ppa:libra-core/ppa -.. code-block:: bash +3. Update the package indexes + +:: + + sudo apt-get update + +4. Install packages + +:: + + sudo apt-get install python-libraclient + + +.. _install-pypi: + +From PyPI +--------- + +The :program:`python-libraclient` package is published on `PyPI `_ and so can be installed using the pip tool, which will manage installing all +python dependencies. + +.. note:: The pip tool isn't bundled by default with some versions of the different distributions, please install it typically using a package manager for the platform you use. + +.. note:: Needs to be done in a Virtual Environment or as root. + +.. code-block:: shell-session + + pip install python-libraclient + +.. warning:: + + The packages on PyPI may lag behind the git repo in functionality. + +.. _install-source: + +Setup the client from source +---------------------------- +If you want the latest version, straight from github: + +.. code-block:: shell-session + + git clone git@github.com:stackforge/python-libraclient.git + cd python-libraclient + virtualenv .venv + source .venv/bin/activate + pip install -r requirements.txt -r test-requirements.txt + python setup.py install + + +.. _install-development: + +Setup the client in development mode +------------------------------------ +Installing in development mode allows your to make changes to the source code & test directly without having to re-run the "python setup.py install" +step. You can find out more about this in the `Development Mode `_ online docs. + +.. code-block:: shell-session + + git clone git@github.com:stackforge/python-libraclient.git + cd python-libraclient + virtualenv .venv + source .venv/bin/activate + pip install -r requirements.txt -r test-requirements.txt + python setup.py develop - sudo apt-get install python-setuptools - sudo python setup.py install