File: index.rst

package info (click to toggle)
python-designateclient 6.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 796 kB
  • sloc: python: 4,496; makefile: 26; sh: 2
file content (45 lines) | stat: -rw-r--r-- 1,493 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
============
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: https://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode
.. _PyPI: https://pypi.org/project/python-designateclient/