Client library for Cyborg API
Go to file
Doug Hellmann ce6e9b2aee fix tox python3 overrides
We want to default to running all tox environments under python 3, so
set the basepython value in each environment.

We do not want to specify a minor version number, because we do not
want to have to update the file every time we upgrade python.

We do not want to set the override once in testenv, because that
breaks the more specific versions used in default environments like
py35 and py36.

Change-Id: I766b8f8d86735669e0f5a1aa1545fda72e5712ca
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2018-07-12 02:20:04 +00:00
cyborgclient base framework for cyborg client. 2018-05-16 09:17:30 +00:00
doc/source Initialize cyborgclient repository 2018-04-12 16:09:57 +00:00
releasenotes Initialize cyborgclient repository 2018-04-12 16:09:57 +00:00
.coveragerc Initialize cyborgclient repository 2018-04-12 16:09:57 +00:00
.gitignore Initialize cyborgclient repository 2018-04-12 16:09:57 +00:00
.gitreview Added .gitreview 2018-03-27 12:10:11 +00:00
.mailmap Initialize cyborgclient repository 2018-04-12 16:09:57 +00:00
.stestr.conf Initialize cyborgclient repository 2018-04-12 16:09:57 +00:00
babel.cfg Initialize cyborgclient repository 2018-04-12 16:09:57 +00:00
CONTRIBUTING.rst Initialize cyborgclient repository 2018-04-12 16:09:57 +00:00
HACKING.rst Initialize cyborgclient repository 2018-04-12 16:09:57 +00:00
LICENSE Initialize cyborgclient repository 2018-04-12 16:09:57 +00:00
README.rst Initialize cyborgclient repository 2018-04-12 16:09:57 +00:00
requirements.txt base framework for cyborg client. 2018-05-16 09:17:30 +00:00
setup.cfg base framework for cyborg client. 2018-05-16 09:17:30 +00:00
setup.py Initialize cyborgclient repository 2018-04-12 16:09:57 +00:00
test-requirements.txt Initialize cyborgclient repository 2018-04-12 16:09:57 +00:00
tox.ini fix tox python3 overrides 2018-07-12 02:20:04 +00:00

Team and repository tags

image

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.

Contents:

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/.