python-tatuclient/doc/source/installation.rst
Venkata Mahesh Jonnalagadda 318048df4b Doc changes for installation webpage
Change-Id: I8dba20b06680262ecd67df7165bd5ec0baed97a2
Closes-Bug: #1563865
2016-03-30 12:03:59 -04:00

46 lines
1.5 KiB
ReStructuredText

============
Installation
============
Install the client from PyPI
----------------------------
The :program:`python-designateclient` package is published on `PyPI`_ and so can be installed using the pip tool, which will manage installing all
python dependencies:
.. code-block:: shell-session
pip install python-designateclient
*Warning: the packages on PyPI may lag behind the git repo in functionality.*
Setup the client from source
----------------------------
If you want the latest version, straight from github:
.. code-block:: shell-session
git clone git@github.com:openstack/python-designateclient.git
cd python-designateclient
virtualenv .venv
. .venv/bin/activate
pip install -r requirements.txt -r test-requirements.txt
python setup.py install
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 `Development Mode`_
.. code-block:: shell-session
git clone git@github.com:openstack/python-designateclient.git
cd python-designateclient
virtualenv .venv
. .venv/bin/activate
pip install -r requirements.txt -r test-requirements.txt
python setup.py develop
.. _Development Mode: http://pythonhosted.org/setuptools/setuptools.html#development-mode
.. _PyPI: https://pypi.python.org/pypi/python-designateclient/