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

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=1. 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=1

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.4.0.tar.gz (57.0 kB view details)

Uploaded Source

Built Distribution

python_cyborgclient-0.4.0-py2.py3-none-any.whl (71.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: python-cyborgclient-0.4.0.tar.gz
  • Upload date:
  • Size: 57.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.5.2

File hashes

Hashes for python-cyborgclient-0.4.0.tar.gz
Algorithm Hash digest
SHA256 f67b422d35c840d8f57ca908c3514cb2d9cdb616311202ea2d83c4197c260ab3
MD5 dabe3853b80bf26bf7d0c95b35325509
BLAKE2b-256 ce96b096cd3f9d3db8cb902f00a2fa030ff9978e7eed5127a647a25d8d128327

See more details on using hashes here.

Provenance

File details

Details for the file python_cyborgclient-0.4.0-py2.py3-none-any.whl.

File metadata

  • Download URL: python_cyborgclient-0.4.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 71.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.5.2

File hashes

Hashes for python_cyborgclient-0.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f32bfb6b30f4f11921dc964222571ebaee92dd96f53d4929c7706ffeef1690b4
MD5 246add84ee92ad6b18b2085e3a96a019
BLAKE2b-256 f40d760410c1d9e8316e57d13af982b78332c68d3031af3261f5dbc513528fe7

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