Metadata-Version: 2.4
Name: openstackclient
Version: 4.0.1.dev51
Summary: OpenStack Command-line Client
Author-email: OpenStack <openstack-discuss@lists.openstack.org>
License: Apache-2.0
Project-URL: Homepage, https://docs.openstack.org/python-openstackclient/
Project-URL: Repository, https://opendev.org/openstack/openstackclient/
Classifier: Environment :: OpenStack
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: pbr!=2.1.0,>=2.0.0
Requires-Dist: networkx>=2.3
Requires-Dist: aodhclient>=0.9.0
Requires-Dist: gnocchiclient>=3.3.1
Requires-Dist: python-barbicanclient>=4.5.2
Requires-Dist: python-designateclient>=2.7.0
Requires-Dist: python-heatclient>=1.10.0
Requires-Dist: python-ironicclient>=2.3.0
Requires-Dist: python-mistralclient!=3.2.0,>=3.1.0
Requires-Dist: python-neutronclient>=6.7.0
Requires-Dist: python-octaviaclient>=1.3.0
Requires-Dist: python-openstackclient>=4.0.0
Requires-Dist: python-troveclient>=2.2.0
Requires-Dist: python-vitrageclient>=1.3.0
Requires-Dist: python-watcherclient>=1.1.0
Requires-Dist: python-zaqarclient>=1.0.0
Requires-Dist: python-zunclient>=3.4.0
Dynamic: license-file
Dynamic: requires-dist

===============
OpenStackClient
===============

.. image:: https://img.shields.io/pypi/v/openstackclient.svg
    :target: https://pypi.org/project/openstackclient/
    :alt: Latest Version

.. image:: https://img.shields.io/pypi/dm/openstackclient.svg
    :target: https://pypi.org/project/openstackclient/
    :alt: Downloads

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 ``openstackclient`` package is a metapackage that installs
``python-openstackclient`` and a number of optional plugins all at the same
time to simplify the installation of OSC.  The major version of
``openstackclient`` will always correspond to the major version of
``python-openstackclient`` that will be installed.

* `PyPi`_ - package installation
* `Online Documentation`_
* `Launchpad project`_ - release management
* `Blueprints`_ - feature specifications
* `Bugs`_ - issue tracking
* `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/openstackclient
.. _Online Documentation: http://docs.openstack.org/developer/python-openstackclient/
.. _Launchpad project: https://launchpad.net/python-openstackclient
.. _Blueprints: https://blueprints.launchpad.net/python-openstackclient
.. _Bugs: https://storyboard.openstack.org/#!/project/975
.. _Source: https://opendev.org/openstack/openstackclient
.. _Developer: http://docs.openstack.org/project-team-guide/project-setup/python.html
.. _Contributing: http://docs.openstack.org/infra/manual/developers.html
.. _Testing: http://docs.openstack.org/developer/python-openstackclient/developing.html#testing

Getting Started
===============

OpenStack Client can be installed from PyPI using pip::

    pip install 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 server create --help
