From 489d5b685b1e213dea6dfbd2e163a482c1cbad2a Mon Sep 17 00:00:00 2001 From: Sebastian Wagner Date: Thu, 26 Sep 2019 11:33:56 +0200 Subject: [PATCH] python-common: Add small Readme Signed-off-by: Sebastian Wagner --- src/python-common/README.rst | 27 +++++++++++++++++++++++++++ src/python-common/setup.py | 5 +++++ 2 files changed, 32 insertions(+) create mode 100644 src/python-common/README.rst diff --git a/src/python-common/README.rst b/src/python-common/README.rst new file mode 100644 index 00000000000..7bd424f7a7b --- /dev/null +++ b/src/python-common/README.rst @@ -0,0 +1,27 @@ +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 + +Requirements +============ + +- ``python-six`` + +Usage +===== + +From within the Ceph git, just import it: + +.. code:: python + + from ceph.deployment_utils import DriveGroupSpec + from ceph.exceptions import OSError diff --git a/src/python-common/setup.py b/src/python-common/setup.py index 9d357baa448..cf1f661cfd4 100644 --- a/src/python-common/setup.py +++ b/src/python-common/setup.py @@ -1,6 +1,10 @@ from setuptools import setup, find_packages +with open("README.rst", "r") as fh: + long_description = fh.read() + + setup( name='ceph', version='1.0.0', @@ -8,6 +12,7 @@ setup( author='', author_email='dev@ceph.io', description='Ceph common library', + long_description=long_description, license='LGPLv2+', keywords='ceph', url="https://github.com/ceph/ceph", -- 2.39.5