Skip to main content

Client library for OpenStack Compute API

Project description

This is a client for the OpenStack Nova API. There’s a Python API (the novaclient module), and a command-line script (nova). Each implements 100% of the OpenStack Nova API.

See the OpenStack CLI guide for information on how to use the nova 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 Github. Patches must be submitted using Gerrit, not Github pull requests.

python-novaclient is licensed under the Apache License like the rest of OpenStack.

Command-line API

Installing this package gets you a shell command, nova, that you can use to interact with any OpenStack cloud.

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-compute-api-version. Or set them as an environment variables as well:

export OS_AUTH_URL=http://example.com:8774/v1.1/
export OS_COMPUTE_API_VERSION=2

If you are using Keystone, you need to set the OS_AUTH_URL to the keystone endpoint:

export OS_AUTH_URL=http://example.com:5000/v2.0/

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 nova help

Python API

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

To use with nova, with keystone as the authentication system:

# use v2.0 auth with http://example.com:5000/v2.0/")
>>> from novaclient.v2 import client
>>> nt = client.Client(USER, PASS, TENANT, AUTH_URL, service_type="compute")
>>> nt.flavors.list()
[...]
>>> nt.servers.list()
[...]
>>> nt.keypairs.list()
[...]

Testing

There are multiple test targets that can be run to validate the code.

  • tox -e pep8 - style guidelines enforcement

  • tox -e py27 - traditional unit testing

  • tox -e functional - live functional testing against an existing openstack

Functional testing assumes the existance of a clouds.yaml file as supported by os-client-config (http://docs.openstack.org/developer/os-client-config) It assumes the existence of a cloud named devstack that behaves like a normal devstack installation with a demo and an admin user/tenant - or clouds named functional_admin and functional_nonadmin.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

python-novaclient-2.26.0.tar.gz (230.1 kB view details)

Uploaded Source

Built Distribution

python_novaclient-2.26.0-py2.py3-none-any.whl (295.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file python-novaclient-2.26.0.tar.gz.

File metadata

File hashes

Hashes for python-novaclient-2.26.0.tar.gz
Algorithm Hash digest
SHA256 725e28e981422e051352a76947dfab05838ee687f3c73a6524d64be8af8a900f
MD5 555c72f4d60292747e3ee34fbec38f28
BLAKE2b-256 3c42f9a3618ab1a7b6feceef3e9db58281764e06c6dc83ffd44857ede92b260a

See more details on using hashes here.

Provenance

File details

Details for the file python_novaclient-2.26.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for python_novaclient-2.26.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 00c0476f4a87c19318c92ad75e0a5652a096d6f96a6a429762b643fb38b3e09b
MD5 d89565621e9851c0ee645303cc18ac91
BLAKE2b-256 d25985f2c44d0ce2bc1ce0a3882e23eb6cd5fb750126a9e2334b39f37316abc9

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