Skip to main content

A client library in python for the Ceph REST API.

Project description

python-cephclient is a python module to communicate with Ceph’s REST API (ceph-rest-api).

This is currently a work in progress.

ABOUT

Client

The cephclient class takes care of sending calls to the API through HTTP and handle the responses. It supports queries for JSON, XML or plain text.

Wrapper

The wrapper class extends the client and provides helper functions to communicate with the API.

Nothing prevents you from calling the client directly exactly like the wrapper does. The wrapper exists for convenience.

Development, Feedback, Bugs

Want to contribute ? Feel free to send pull requests !

Have problems, bugs, feature ideas ? I am using the github issue tracker to manage them.

HOW TO USE

Installation

Install the package through pip:

pip install python-cephclient

Instanciate CephWrapper:

from cephclient import *

wrapper = CephWrapper(
    endpoint = 'http://apiserver:5000/api/v0.1/',
    debug = True # Optionally increases the verbosity of the client
)

Do your request and specify the reponse type you are expecting.

Either json, xml or text (default) are available.

text:

response, body = wrapper.get_fsid(body = 'text')
print(response)

====

d5252e7d-75bc-4083-85ed-fe51fa83f62b

json:

response, body = wrapper.get_fsid(body = 'json')
print(json.dumps(body, indent=4, separators=(',', ': ')))

====

{
    "status": "OK",
    "output": {
        "fsid": "d5252e7d-75bc-4083-85ed-fe51fa83f62b"
    }
}

xml:

response, body = wrapper.get_fsid(body = 'xml')
print(etree.tostring(body, pretty_print=True))

====

<response>
  <output>
    <fsid><fsid>d5252e7d-75bc-4083-85ed-fe51fa83f62b</fsid></fsid>
  </output>
  <status>
    OK
  </status>
</response>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-cephclient-0.1.0.1.tar.gz (7.7 kB view details)

Uploaded Source

File details

Details for the file python-cephclient-0.1.0.1.tar.gz.

File metadata

File hashes

Hashes for python-cephclient-0.1.0.1.tar.gz
Algorithm Hash digest
SHA256 962dc09e70a97620fd891ce49c06f9b458732d81f72fe9f604f7d17aa0607e7d
MD5 0871c2c80548637aa96933708d957199
BLAKE2b-256 dc11881679bc1a30105157ca687cc01fed8cdefaf4e6dd00e02c4484e726f0ca

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page