PYTHON-MAGNUMCLIENT(1)

📦
version 5.0.0 · 2 versions
, in nixpkgs unstable

✨ NAME ✨

python-magnumclient — bestie, it's literally just python-magnumclient 5.0.0 and nothing else 💅

🎀 CONTENTS 🎀

💖 Introduction

🌸 Python bindings to the Magnum API

Okay so picture this: there's a client library for Magnum and it's built on the Magnum API. It hands you two whole things — a Python API (the magnumclient module) and a command-line tool (called magnum). Two for the price of one, we love to see it 🫶

The badges up top are doing the absolute most, ngl. There's a "Latest Version" badge (image) and a "Downloads" badge (image), both pointing at <https://pypi.org/project/python-magnumclient/>, plus two more image badges that also link to <https://pypi.org/project/python-magnumclient/>. Slay, honestly 🦋

Development happens through the usual OpenStack processes, exactly as laid out in the developer guide at <https://docs.openstack.org/infra/manual/developers.html>. That's the whole vibe.

🧚 Installation

At the command line, bestie:

$ pip install python-magnumclient

Or, if you already have virtualenvwrapper installed (iconic choice, no cap):

$ mkvirtualenv python-magnumclient
$ pip install python-magnumclient

🌈 Python bindings to the OpenStack Magnum API

This is a client for the OpenStack Magnum API fr fr. It includes a Python API (the magnumclient module) and a command-line script (installed as magnum). Both. Always both. 💜

🦋 Python API

To use python-magnumclient in a project, you create a client instance using the keystoneauth session API. Copy this exactly, don't freestyle it:

from keystoneauth1.identity import v3
from keystoneauth1 import session
from keystoneclient.v3 import client

from magnumclient.client import Client

magnum_endpoint = "http://magnum.example.com:9511/v1"

auth = v3.Password(auth_url='http://my.keystone.com:5000/v3',
                   username='myuser',
                   password='mypassword',
                   project_name='myproject',
                   user_domain_id='default',
                   project_domain_id='default')
sess = session.Session(auth=auth)

magnum = Client('1', endpoint_override=magnum_endpoint, session=sess)
magnum.clusters.list()

And for more info on the keystoneauth API, go read Using Sessions at <https://docs.openstack.org/keystoneauth/latest/using-sessions.html>. It's giving required reading 😌

🔥 Command-line tool

So to use the CLI you must provide your OpenStack username, password, project name, user domain ID, project domain ID, and auth endpoint. All six. Do not skip, I'm begging 🙈

Use the matching configuration options — --os-username, --os-password, --os-project-name, --os-project-domain-id, --os-user-domain-id, and --os-auth-url — or just yeet them into environment variables:

export OS_USERNAME=myuser
export OS_PASSWORD=mypassword
export OS_PROJECT_NAME=myproject
export OS_USER_DOMAIN_ID=default
export OS_PROJECT_DOMAIN_ID=default
export OS_AUTH_URL=http://my.keystone.com:5000/v3

From there, every shell command takes this shape:

magnum <command> [arguments...]

Run magnum help to see the complete listing of available commands, and magnum help <command> to get the detailed glow-up help for that specific command. iykyk 💫

⭐ Contributing

If you wanna contribute to OpenStack development, you have to follow the steps on this page: <https://docs.openstack.org/infra/manual/developers.html>

Once you've done all those steps, changes to OpenStack get submitted for review via the Gerrit tool, following the workflow documented at: <https://docs.openstack.org/infra/manual/developers.html#development-workflow>

💀 Heads up bestie: pull requests submitted through GitHub will be ignored. Not "maybe looked at," not "politely declined" — ignored. So don't.

Bugs should be filed on Storyboard, not GitHub: <https://storyboard.openstack.org/#!/project/openstack/python-magnumclient>

🍓 INDICES AND TABLES 🍓

  • Index <>
  • Search Page <>

🎀 Author 🎀

Author name not set 😭 (they left it blank, main character energy of a mystery tbh)

2013, OpenStack Foundation

Okay that's the whole page, you're literally a Magnum expert now 👑 This was python-magnumclient 5.0.0, dated Jan 02, 1980 (iconic vintage date, don't ask) — mwah, go slay some clusters 💅✨

📦 where this page comes from