Skip to main content

Python client for cyborg API

Project description

Team and repository tags

https://governance.openstack.org/tc/badges/python-cyborgclient.svg

python-cyborgclient

Latest Version Downloads

python-cyborgclient is a python bindings to the OpenStack Cyborg API. There’s a Python API (the cyborgclient module), and a command-line script (cyborg). Each implements 100% of the OpenStack Cyborg API.

See the OpenStack CLI Reference for information on how to use the cyborg command-line tool. You may also want to look at the OpenStack API documentation.

The project is hosted on Launchpad, where bugs can be filed. The code is hosted on OpenStack. Patches must be submitted using Gerrit.

This code is a fork of Jacobian’s python-cloudservers. If you need API support for the Rackspace API solely or the BSD license, you should use that repository. python-cyborgclient is licensed under the Apache License like the rest of OpenStack.

Command-line API

Installing this package gets you a shell command, cyborg, that you can use to interact with any Rackspace compatible API (including OpenStack).

You’ll need to provide your OpenStack username and password. You can do this with the --os-username, --os-password and --os-tenant-name params, but it’s easier to just set them as environment variables:

export OS_USERNAME=openstack
export OS_PASSWORD=yadayada
export OS_TENANT_NAME=myproject

You will also need to define the authentication url with --os-auth-url and the version of the API with --os-accelerator-api-version. Or set them as environment variables as well, OS_ACCELERATOR_API_VERSION=3. If you are using Keystone, you need to set the OS_AUTH_URL to the keystone endpoint:

export OS_AUTH_URL=http://controller:5000/v3
export OS_ACCELERATOR_API_VERSION=3

Since Keystone can return multiple regions in the Service Catalog, you can specify the one you want with --os-region-name (or export OS_REGION_NAME). It defaults to the first in the list returned.

You’ll find complete documentation on the shell by running cyborg help

Python API

There’s also a complete Python API, but it has not yet been documented.

Quick-start using keystone:

# use v3 auth with http://controller:5000/v3
>>> from cyborgclient import client
>>> nt = client.Client(USERNAME, PASSWORD, PROJECT_ID, AUTH_URL)
>>> nt.accelerators.list()
[...]

See release notes and more at https://docs.openstack.org/python-cyborgclient/latest/.

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-cyborgclient-0.1.0.tar.gz (48.9 kB view details)

Uploaded Source

Built Distribution

python_cyborgclient-0.1.0-py2-none-any.whl (50.5 kB view details)

Uploaded Python 2

File details

Details for the file python-cyborgclient-0.1.0.tar.gz.

File metadata

File hashes

Hashes for python-cyborgclient-0.1.0.tar.gz
Algorithm Hash digest
SHA256 eb1b64866417e5d9f99080ea0b9e685732af4491e5c839a7ccddad54099b4e5e
MD5 1467ddc0b419d31d66eea177ce103bdf
BLAKE2b-256 a426cb7c28a3ef07a00ae8ef8746444c2aadc55079375f48514ef81097b1ee48

See more details on using hashes here.

Provenance

File details

Details for the file python_cyborgclient-0.1.0-py2-none-any.whl.

File metadata

File hashes

Hashes for python_cyborgclient-0.1.0-py2-none-any.whl
Algorithm Hash digest
SHA256 683a286fbe42c2f1e605d14d67b1f7641f3c637811a9dc6a9d7506da116198d0
MD5 8a51b687832dcf91298120a44622d9f2
BLAKE2b-256 78699523c0a5a368cfcdf289395a7af062083a7df3b7e9cbdb52cb3832ebeedb

See more details on using hashes here.

Provenance

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