kgess-mirror/openstackclient
1
0
Fork 0
mirror of https://opendev.org/openstack/openstackclient.git synced 2026-01-16 23:10:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Unified CLI with all python-openstackclient plugins
41 commits 1 branch 2 tags 963 KiB
Find a file
Sanu Madhavan 3cc682c19d Removes unused utf-8 declaration 
Following files contain #-*- coding: utf-8 -*- declaration
but don't contain any unicode character

Change-Id: Iec6d4b867a4e079a07d5f0f653ab443085eb4ab5
2019-09-11 04:34:39 +00:00
doc Removes unused utf-8 declaration 2019-09-11 04:34:39 +00:00
playbooks/openstackclient-check-plugins OpenDev Migration Patch 2019-04-19 19:35:52 +00:00
tests Removes unused utf-8 declaration 2019-09-11 04:34:39 +00: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 Add Python 3 Train unit tests 2019-07-09 09:56:54 -04:00
LICENSE Initial commit for the OSC metapackage repo. 2017-01-06 14:39:22 -06:00
README.rst update git.openstack.org to opendev 2019-04-25 13:41:32 +00:00
requirements.txt Update sphinx dependency for python 2.7 2019-05-29 15:23:29 +02:00
setup.cfg Add Python 3 Train unit tests 2019-07-09 09:56:54 -04:00
setup.py Updated from global requirements 2017-05-17 03:55:54 +00:00
test-requirements.txt Switch to openstackdocstheme 2019-05-29 15:23:32 +02:00
tox.ini Add Python 3 Train unit tests 2019-07-09 09:56:54 -04: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, 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`_ - 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://bugs.launchpad.net/python-openstackclient
.. _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