kgess-mirror/openstackclient
1
0
Fork 0
mirror of https://opendev.org/openstack/openstackclient.git synced 2026-01-12 07:03:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Unified CLI with all python-openstackclient plugins
65 commits 1 branch 2 tags 963 KiB
Find a file
Andreas Jaeger e0fa40ff61 Update to hacking 3.0 
Hacking 3.0 was just released with minor changes, update to the new
version.

Change-Id: Id221668c8fcda2338cfd8eaed6e5979038966880
2020-03-30 16:59:47 +02:00
doc [ussuri][goal] Drop python 2.7 support and testing 2020-02-04 20:45:20 +01:00
playbooks/openstackclient-check-plugins Use python3 for openstackclient-check-plugins job 2020-01-07 19:01:40 +00:00
tests Update hacking for Python3 2020-03-27 21:02:40 +01:00
.gitignore Switch to stestr 2018-07-10 16:25:53 +07:00
.gitreview OpenDev Migration Patch 2019-04-19 19:35:52 +00:00
.stestr.conf Switch to stestr 2018-07-10 16:25:53 +07:00
.zuul.yaml [ussuri][goal] Drop python 2.7 support and testing 2020-02-04 20:45:20 +01:00
LICENSE Initial commit for the OSC metapackage repo. 2017-01-06 14:39:22 -06:00
README.rst Prepare for OSC 4.0 release 2019-09-12 08:37:27 -05:00
requirements.txt [ussuri][goal] Drop python 2.7 support and testing 2020-02-04 20:45:20 +01:00
setup.cfg [ussuri][goal] Drop python 2.7 support and testing 2020-02-04 20:45:20 +01:00
setup.py [ussuri][goal] Drop python 2.7 support and testing 2020-02-04 20:45:20 +01:00
test-requirements.txt Update to hacking 3.0 2020-03-30 16:59:47 +02:00
tox.ini Update hacking for Python3 2020-03-27 21:02:40 +01:00

README.rst 

===============
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 Freenode (irc.freenode.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