Use OpenStack from Python

This guide connects from Python with the OpenStack SDK, the standard Python library for OpenStack services.

Before you beginCopy Anchor Link

You need Python 3.10 or later, and either a clouds.yaml entry from Set up the CLI or an application credential.

1. Install the SDKCopy Anchor Link

pip install openstacksdk

2. ConnectCopy Anchor Link

Connect with the same clouds.yaml entry the CLI uses:

import openstack

conn = openstack.connect(cloud="vexxhost")

Or pass an application credential directly:

import openstack

conn = openstack.connect(
    auth_type="v3applicationcredential",
    auth_url="https://auth.vexxhost.net/v3",
    application_credential_id="3c2b8e1f4a6d4c0e9b7a5f3d1e2c4b6a",
    application_credential_secret="Jq7mX2vL9pR4tW8yZ1bC5nF3hK6dS0gAuE2iO7qT4wY9rU1oP3aL6sD8fG5hJ2kZ0xC7vB4nM1qW8eR3tY6u",
    region_name="<region>",
)

The connection gets tokens and renews them when they expire, and it finds each service in the service catalog.

3. Make a callCopy Anchor Link

for project in conn.identity.user_projects(conn.current_user_id):
    print(project.id, project.name)

The SDK has a proxy for each OpenStack service, such as conn.compute, conn.network and conn.block_storage.

4. Use the session with other clientsCopy Anchor Link

Some services have their own client library. Those clients take a keystoneauth session, and the connection has one, already signed in:

client = Client("1", session=conn.session)

Each product's documentation names its client library.

5. Handle errorsCopy Anchor Link

A failed request raises an exception from openstack.exceptions, such as NotFoundException, ForbiddenException or ConflictException. Each carries the details of the response:

from openstack import exceptions

try:
    conn.identity.get_project("7d3e9b1c5a2f4e8d9c6b0a1f3e5d7c9b")
except exceptions.HttpException as error:
    print(error.status_code, error.request_id, error.details)
    raise

Next stepsCopy Anchor Link

• Read the OpenStack SDK documentation for every service's calls.
• Make API requests to services directly.