========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/tc/badges/python-openstackclient.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
===============
OpenStackClient
===============
.. image:: https://img.shields.io/pypi/v/python-openstackclient.svg
:target: https://pypi.org/project/python-openstackclient/
:alt: Latest Version
OpenStackClient (aka OSC) is a command-line client for OpenStack that brings
the command set for Compute, Identity, Image, Network, Object Store and Block
Storage APIs together in a single shell with a uniform command structure.
The primary goal is to provide a unified shell command structure and a common
language to describe operations in OpenStack.
* `PyPi`_ - package installation
* `Online Documentation`_
* `Launchpad project`_ - bugs and feature requests
* `Blueprints`_ - feature specifications (historical only)
* `Source`_
* `Developer`_ - getting started as a developer
* `Contributing`_ - contributing code
* `Testing`_ - testing code
* IRC: #openstack-sdks on OFTC (irc.oftc.net)
* License: Apache 2.0
.. _PyPi: https://pypi.org/project/python-openstackclient
.. _Online Documentation: https://docs.openstack.org/python-openstackclient/latest/
.. _Blueprints: https://blueprints.launchpad.net/python-openstackclient
.. _`Launchpad project`: https://bugs.launchpad.net/python-openstackclient
.. _Source: https://opendev.org/openstack/python-openstackclient
.. _Developer: https://docs.openstack.org/project-team-guide/project-setup/python.html
.. _Contributing: https://docs.openstack.org/infra/manual/developers.html
.. _Testing: https://docs.openstack.org/python-openstackclient/latest/contributor/developing.html#testing
.. _Release Notes: https://docs.openstack.org/releasenotes/python-openstackclient
Getting Started
===============
OpenStack Client can be installed from PyPI using pip::
pip install python-openstackclient
There are a few variants on getting help. A list of global options and supported
commands is shown with ``--help``::
openstack --help
There is also a ``help`` command that can be used to get help text for a specific
command::
openstack help
openstack help server create
If you want to make changes to the OpenStackClient for testing and contribution,
make any changes and then run::
python setup.py develop
or::
pip install -e .
Configuration
=============
The CLI is configured via environment variables and command-line
options as listed in https://docs.openstack.org/python-openstackclient/latest/cli/authentication.html.
Authentication using username/password is most commonly used:
- For a local user, your configuration will look like the one below::
export OS_AUTH_URL=<url-to-openstack-identity>
export OS_IDENTITY_API_VERSION=3
export OS_PROJECT_NAME=<project-name>
export OS_PROJECT_DOMAIN_NAME=<project-domain-name>
export OS_USERNAME=<username>
export OS_USER_DOMAIN_NAME=<user-domain-name>
export OS_PASSWORD=<password> # (optional)
The corresponding command-line options look very similar::
--os-auth-url <url>
--os-identity-api-version 3
--os-project-name <project-name>
--os-project-domain-name <project-domain-name>
--os-username <username>
--os-user-domain-name <user-domain-name>
[--os-password <password>]
- For a federated user, your configuration will look the so::
export OS_PROJECT_NAME=<project-name>
export OS_PROJECT_DOMAIN_NAME=<project-domain-name>
export OS_AUTH_URL=<url-to-openstack-identity>
export OS_IDENTITY_API_VERSION=3
export OS_AUTH_PLUGIN=openid
export OS_AUTH_TYPE=v3oidcpassword
export OS_USERNAME=<username-in-idp>
export OS_PASSWORD=<password-in-idp>
export OS_IDENTITY_PROVIDER=<the-desired-idp-in-keystone>
export OS_CLIENT_ID=<the-client-id-configured-in-the-idp>
export OS_CLIENT_SECRET=<the-client-secred-configured-in-the-idp>
export OS_OPENID_SCOPE=<the-scopes-of-desired-attributes-to-claim-from-idp>
export OS_PROTOCOL=<the-protocol-used-in-the-apache2-oidc-proxy>
export OS_ACCESS_TOKEN_TYPE=<the-access-token-type-used-by-your-idp>
export OS_DISCOVERY_ENDPOINT=<the-well-known-endpoint-of-the-idp>
The corresponding command-line options look very similar::
--os-project-name <project-name>
--os-project-domain-name <project-domain-name>
--os-auth-url <url-to-openstack-identity>
--os-identity-api-version 3
--os-auth-plugin openid
--os-auth-type v3oidcpassword
--os-username <username-in-idp>
--os-password <password-in-idp>
--os-identity-provider <the-desired-idp-in-keystone>
--os-client-id <the-client-id-configured-in-the-idp>
--os-client-secret <the-client-secred-configured-in-the-idp>
--os-openid-scope <the-scopes-of-desired-attributes-to-claim-from-idp>
--os-protocol <the-protocol-used-in-the-apache2-oidc-proxy>
--os-access-token-type <the-access-token-type-used-by-your-idp>
--os-discovery-endpoint <the-well-known-endpoint-of-the-idp>
If a password is not provided above (in plaintext), you will be interactively
prompted to provide one securely.
Raw data
{
"_id": null,
"home_page": "https://docs.openstack.org/python-openstackclient/latest/",
"name": "python-openstackclient",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "OpenStack",
"author_email": "openstack-discuss@lists.openstack.org",
"download_url": "https://files.pythonhosted.org/packages/0c/cf/e4a406f652ac42195b6643e0c5e2419be92a80b373d601bac73fc66daf57/python-openstackclient-7.2.0.tar.gz",
"platform": null,
"description": "========================\nTeam and repository tags\n========================\n\n.. image:: https://governance.openstack.org/tc/badges/python-openstackclient.svg\n :target: https://governance.openstack.org/tc/reference/tags/index.html\n\n.. Change things from this point on\n\n===============\nOpenStackClient\n===============\n\n.. image:: https://img.shields.io/pypi/v/python-openstackclient.svg\n :target: https://pypi.org/project/python-openstackclient/\n :alt: Latest Version\n\nOpenStackClient (aka OSC) is a command-line client for OpenStack that brings\nthe command set for Compute, Identity, Image, Network, Object Store and Block\nStorage APIs together in a single shell with a uniform command structure.\n\nThe primary goal is to provide a unified shell command structure and a common\nlanguage to describe operations in OpenStack.\n\n* `PyPi`_ - package installation\n* `Online Documentation`_\n* `Launchpad project`_ - bugs and feature requests\n* `Blueprints`_ - feature specifications (historical only)\n* `Source`_\n* `Developer`_ - getting started as a developer\n* `Contributing`_ - contributing code\n* `Testing`_ - testing code\n* IRC: #openstack-sdks on OFTC (irc.oftc.net)\n* License: Apache 2.0\n\n.. _PyPi: https://pypi.org/project/python-openstackclient\n.. _Online Documentation: https://docs.openstack.org/python-openstackclient/latest/\n.. _Blueprints: https://blueprints.launchpad.net/python-openstackclient\n.. _`Launchpad project`: https://bugs.launchpad.net/python-openstackclient\n.. _Source: https://opendev.org/openstack/python-openstackclient\n.. _Developer: https://docs.openstack.org/project-team-guide/project-setup/python.html\n.. _Contributing: https://docs.openstack.org/infra/manual/developers.html\n.. _Testing: https://docs.openstack.org/python-openstackclient/latest/contributor/developing.html#testing\n.. _Release Notes: https://docs.openstack.org/releasenotes/python-openstackclient\n\nGetting Started\n===============\n\nOpenStack Client can be installed from PyPI using pip::\n\n pip install python-openstackclient\n\nThere are a few variants on getting help. A list of global options and supported\ncommands is shown with ``--help``::\n\n openstack --help\n\nThere is also a ``help`` command that can be used to get help text for a specific\ncommand::\n\n openstack help\n openstack help server create\n\nIf you want to make changes to the OpenStackClient for testing and contribution,\nmake any changes and then run::\n\n python setup.py develop\n\nor::\n\n pip install -e .\n\nConfiguration\n=============\n\nThe CLI is configured via environment variables and command-line\noptions as listed in https://docs.openstack.org/python-openstackclient/latest/cli/authentication.html.\n\nAuthentication using username/password is most commonly used:\n\n- For a local user, your configuration will look like the one below::\n\n export OS_AUTH_URL=<url-to-openstack-identity>\n export OS_IDENTITY_API_VERSION=3\n export OS_PROJECT_NAME=<project-name>\n export OS_PROJECT_DOMAIN_NAME=<project-domain-name>\n export OS_USERNAME=<username>\n export OS_USER_DOMAIN_NAME=<user-domain-name>\n export OS_PASSWORD=<password> # (optional)\n\n The corresponding command-line options look very similar::\n\n --os-auth-url <url>\n --os-identity-api-version 3\n --os-project-name <project-name>\n --os-project-domain-name <project-domain-name>\n --os-username <username>\n --os-user-domain-name <user-domain-name>\n [--os-password <password>]\n\n- For a federated user, your configuration will look the so::\n\n export OS_PROJECT_NAME=<project-name>\n export OS_PROJECT_DOMAIN_NAME=<project-domain-name>\n export OS_AUTH_URL=<url-to-openstack-identity>\n export OS_IDENTITY_API_VERSION=3\n export OS_AUTH_PLUGIN=openid\n export OS_AUTH_TYPE=v3oidcpassword\n export OS_USERNAME=<username-in-idp>\n export OS_PASSWORD=<password-in-idp>\n export OS_IDENTITY_PROVIDER=<the-desired-idp-in-keystone>\n export OS_CLIENT_ID=<the-client-id-configured-in-the-idp>\n export OS_CLIENT_SECRET=<the-client-secred-configured-in-the-idp>\n export OS_OPENID_SCOPE=<the-scopes-of-desired-attributes-to-claim-from-idp>\n export OS_PROTOCOL=<the-protocol-used-in-the-apache2-oidc-proxy>\n export OS_ACCESS_TOKEN_TYPE=<the-access-token-type-used-by-your-idp>\n export OS_DISCOVERY_ENDPOINT=<the-well-known-endpoint-of-the-idp>\n\n The corresponding command-line options look very similar::\n\n --os-project-name <project-name>\n --os-project-domain-name <project-domain-name>\n --os-auth-url <url-to-openstack-identity>\n --os-identity-api-version 3\n --os-auth-plugin openid\n --os-auth-type v3oidcpassword\n --os-username <username-in-idp>\n --os-password <password-in-idp>\n --os-identity-provider <the-desired-idp-in-keystone>\n --os-client-id <the-client-id-configured-in-the-idp>\n --os-client-secret <the-client-secred-configured-in-the-idp>\n --os-openid-scope <the-scopes-of-desired-attributes-to-claim-from-idp>\n --os-protocol <the-protocol-used-in-the-apache2-oidc-proxy>\n --os-access-token-type <the-access-token-type-used-by-your-idp>\n --os-discovery-endpoint <the-well-known-endpoint-of-the-idp>\n\nIf a password is not provided above (in plaintext), you will be interactively\nprompted to provide one securely.\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "OpenStack Command-line Client",
"version": "7.2.0",
"project_urls": {
"Homepage": "https://docs.openstack.org/python-openstackclient/latest/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4941c661672835da6da58db090589e606deba00312fd8d75f810ec2bea0ab812",
"md5": "e2f2f23d1560489ac93793ef755a8e62",
"sha256": "77811ba71f740a121e8dfde5e0e57c7067cc9f80e1703c66e30920e973230242"
},
"downloads": -1,
"filename": "python_openstackclient-7.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e2f2f23d1560489ac93793ef755a8e62",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 1121686,
"upload_time": "2024-10-18T10:39:21",
"upload_time_iso_8601": "2024-10-18T10:39:21.164068Z",
"url": "https://files.pythonhosted.org/packages/49/41/c661672835da6da58db090589e606deba00312fd8d75f810ec2bea0ab812/python_openstackclient-7.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0ccfe4a406f652ac42195b6643e0c5e2419be92a80b373d601bac73fc66daf57",
"md5": "f388cf3d04303822d19acdb738b146eb",
"sha256": "f637b75bbf0f537899263cd53123d73f1059d2f318639c522c903dcc127b3b92"
},
"downloads": -1,
"filename": "python-openstackclient-7.2.0.tar.gz",
"has_sig": false,
"md5_digest": "f388cf3d04303822d19acdb738b146eb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 947396,
"upload_time": "2024-10-18T10:39:23",
"upload_time_iso_8601": "2024-10-18T10:39:23.022374Z",
"url": "https://files.pythonhosted.org/packages/0c/cf/e4a406f652ac42195b6643e0c5e2419be92a80b373d601bac73fc66daf57/python-openstackclient-7.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-18 10:39:23",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "python-openstackclient"
}
JSON