d4a5555e52
* Improve index page to explain the difference between v1 and v2 CLI support. * Add a v2 examples page * Add all supported commands to v2 shell page * Add a tox task to build the docs * Fix a bug building the docs with an invalid html_static_path config Change-Id: Ie1e65c2d0cc8ad1b8b258e03114e19a943d1d19c Closes-Bug: 1572217
46 lines
1.1 KiB
ReStructuredText
46 lines
1.1 KiB
ReStructuredText
======================
|
|
python-designateclient
|
|
======================
|
|
|
|
python-designateclient provides python bindings and command line tools for both
|
|
Designate v1 and v2 APIs.
|
|
|
|
The :doc:`Python API bindings <bindings>` are provided by the
|
|
:program:`designateclient` module.
|
|
|
|
There are two separate command line interfaces to work with the two API
|
|
versions:
|
|
|
|
v2: the designate plugin for the :program:`openstack` command line tool. More information can be
|
|
found on the :doc:`designate v2 command line tool page <shell-v2>`.
|
|
|
|
v1: the :program:`designate` command line tool. More information can be found
|
|
on the :doc:`designate v1 command line tool page <shell>`.
|
|
|
|
You'll need credentials for an OpenStack cloud that implements the Designate
|
|
API in order to use the client.
|
|
|
|
Contents
|
|
======================
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
installation
|
|
bindings
|
|
shell-v2
|
|
shell-v2-examples
|
|
shell
|
|
shell-examples
|
|
contributing
|
|
functional-tests
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|
|
|
|
.. _Cloud DNS: http://www.hpcloud.com/products-services/dns
|