diff options
Diffstat (limited to 'src/python-common/README.rst')
| -rw-r--r-- | src/python-common/README.rst | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/src/python-common/README.rst b/src/python-common/README.rst new file mode 100644 index 000000000..3900ec4f9 --- /dev/null +++ b/src/python-common/README.rst @@ -0,0 +1,22 @@ +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 |