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:

# pass auth plugin and session to Client init.
# service_parameters contains servive_name, service_type, interface and
# region name.
>>> from cyborgclient.v1 import client
>>> nt = client.Client(auth=auth,session=_SESSION,**service_parameters)
>>> 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.2.0.tar.gz (49.1 kB view details)

Uploaded Source

Built Distribution

python_cyborgclient-0.2.0-py3-none-any.whl (51.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python-cyborgclient-0.2.0.tar.gz
  • Upload date:
  • Size: 49.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/2.7.12

File hashes

Hashes for python-cyborgclient-0.2.0.tar.gz
Algorithm Hash digest
SHA256 eac0f317ba383a436e27eb321a0b3d02036711fb006ad352f8c5616324571527
MD5 bf150d0a431faaa7dcab64317a50d0a5
BLAKE2b-256 7bedc8184e4d9df45eaaf255430d82ba7edc1408edc247c7d205cb4e1cc6a6be

See more details on using hashes here.

Provenance

File details

Details for the file python_cyborgclient-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: python_cyborgclient-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 51.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/2.7.12

File hashes

Hashes for python_cyborgclient-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0eaa3bb0bed09432009cc0223f3a3aff044d184b1325d59824f2a2d607c64d0b
MD5 c1b9aa5302040a89f074ff97633aa3ff
BLAKE2b-256 9984dc0075db5f7f8706b5ba3ddf55c7dd1e9ea1c78e7ea06930fbd9f6550557

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