69da9cd231
Documentation is modeled after python-novaclient docs. (http://docs.openstack.org/developer/python-novaclient/) Built preview for reviewers: https://nsaje.fedorapeople.org/python-ceilometerclient/ Change-Id: I61e9d6593e4a1aea5cf018081416d4be3a9372ac
48 lines
1.2 KiB
ReStructuredText
48 lines
1.2 KiB
ReStructuredText
Python bindings to the OpenStack Ceilometer API
|
|
==================================================
|
|
|
|
This is a client for OpenStack Ceilometer API. There's :doc:`a Python API
|
|
<api>` (the :mod:`ceilometerclient` module), and a :doc:`command-line script
|
|
<shell>` (installed as :program:`ceilometer`). Each implements the entire
|
|
OpenStack Ceilometer API.
|
|
|
|
.. seealso::
|
|
|
|
You may want to read the `OpenStack Ceilometer Developer Guide`__ -- the overview, at
|
|
least -- to get an idea of the concepts. By understanding the concepts
|
|
this library should make more sense.
|
|
|
|
__ http://docs.openstack.org/developer/ceilometer/
|
|
|
|
Contents:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
shell
|
|
api
|
|
ref/index
|
|
ref/v1/index
|
|
ref/v2/index
|
|
releases
|
|
|
|
Contributing
|
|
============
|
|
|
|
Code is hosted at `git.openstack.org`_. Submit bugs to the Ceilometer project on
|
|
`Launchpad`_. Submit code to the openstack/python-ceilometerclient project using
|
|
`Gerrit`_.
|
|
|
|
.. _git.openstack.org: https://git.openstack.org/cgit/openstack/python-ceilometerclient
|
|
.. _Launchpad: https://launchpad.net/ceilometer
|
|
.. _Gerrit: http://wiki.openstack.org/GerritWorkflow
|
|
|
|
Run tests with ``python setup.py test``.
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|