summaryrefslogtreecommitdiff
path: root/doc/source/index.rst
blob: eabd8513390a5b8d38b0f0278f3d1eefe3e1ff96 (plain)
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
46
47
48
49
50
51
52
53
54
55
56
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.

    __ https://docs.openstack.org/ceilometer/latest/

Contents:

.. toctree::
   :maxdepth: 2

   shell
   api
   ref/index
   ref/v2/index

The command-line client
=======================

The ceilometer client is the command-line interface (CLI) for
the Telemetry Data Collection service (ceilometer) API
and its extensions.

.. toctree::

   cli

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: https://docs.openstack.org/infra/manual/developers.html#development-workflow

Run tests with ``python setup.py test``.

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`