[ceph.git] / ceph / src / python-common / README.rst

ceph-python-common
==================

This library is meant to be used to keep common data structures and
functions usable throughout the Ceph project.

Like for example:

- All different Cython bindings.
- MGR modules.
- ``ceph`` command line interface and other Ceph tools.
- Also external tools.

Usage
=====

From within the Ceph git, just import it:

.. code:: python

    from ceph.deployment_utils import DriveGroupSpec
    from ceph.exceptions import OSError
Commit	Line	Data
9f95a23c TL	1	ceph-python-common
	2	==================
	3
	4	This library is meant to be used to keep common data structures and
	5	functions usable throughout the Ceph project.
	6
	7	Like for example:
	8
	9	- All different Cython bindings.
	10	- MGR modules.
	11	- ``ceph`` command line interface and other Ceph tools.
	12	- Also external tools.
	13
9f95a23c TL	14	Usage
	15	=====
	16
	17	From within the Ceph git, just import it:
	18
	19	.. code:: python
	20
	21	from ceph.deployment_utils import DriveGroupSpec
	22	from ceph.exceptions import OSError