113cd72ea8
This patch adds the initial Sphinx layout for building docs. It also contains a bare set of initial pages that will be fleshed out in following patches. Change-Id: Iceedcd268816cab9675795e107a5905de093e2d9 Implements: blueprint create-initial-documentation
48 lines
1009 B
ReStructuredText
48 lines
1009 B
ReStructuredText
Python bindings to the OpenStack Tuskar API
|
|
===========================================
|
|
|
|
This is a client for OpenStack Tuskar API. There's a Python API
|
|
(the :mod:`tuskarclient` module), and a command-line script
|
|
(installed as :program:`tuskar`).
|
|
|
|
Python API
|
|
==========
|
|
|
|
You can use the API like so::
|
|
|
|
>>> from tuskarclient.client import Client
|
|
>>> tuskar = Client('1', endpoint=tuskar_url)
|
|
|
|
Reference
|
|
---------
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
ref/index
|
|
ref/v1/index
|
|
|
|
Command-line Tool
|
|
=================
|
|
|
|
The client can also be used with the CLI.
|
|
|
|
Man Pages
|
|
=========
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
man/tuskar
|
|
|
|
Contributing
|
|
============
|
|
|
|
Code is hosted `on OpenStack git`_. Submit bugs to the Tuskar project on
|
|
`Launchpad`_. Submit code to the openstack/python-tuskarclient project
|
|
using `Gerrit`_.
|
|
|
|
.. _on OpenStack git: http://git.openstack.org/cgit/openstack/python-tuskarclient
|
|
.. _Launchpad: https://launchpad.net/python-tuskarclient
|
|
.. _Gerrit: http://wiki.openstack.org/GerritWorkflow
|