openstack/python-openstackclient
Code Issues Proposed changes
9f471eede9
python-openstackclient/doc/source/index.rst
Stephen Finucane be1e6ca1d8 docs: Don't include ChangeLog 
The ChangeLog is built using commit message summary lines. Unfortunately
some of these contain invalid rST markup. There's no way to
retroactively fix this, so simply stop including the doc.

Change-Id: I6600c1baf142fe4c776f1ae170faa3f6a87b330c
2017-03-20 16:35:01 +00:00

2.7 KiB
Raw Blame History

OpenStackClient

OpenStackClient (aka OSC) is a command-line client for OpenStack that brings the command set for Compute, Identity, Image, Object Storage and Block Storage APIs together in a single shell with a uniform command structure.

User Documentation

Manual Page <man/openstack> command-list commands configuration plugins plugin-commands authentication interactive humaninterfaceguide backwards-incompatible

decoder

Getting Started

Release Notes

Developer Documentation

developing command-beta command-options command-wrappers command-errors command-logs specs/commands

Project Goals

  • Use the OpenStack Python API libraries, extending or replacing them as required
  • Use a consistent naming and structure for commands and arguments
  • Provide consistent output formats with optional machine parseable formats
  • Use a single-binary approach that also contains an embedded shell that can execute multiple commands on a single authentication (see libvirt's virsh for an example)
  • Independence from the OpenStack project names; only API names are referenced (to the extent possible)

Contributing

OpenStackClient utilizes all of the usual OpenStack processes and requirements for contributions. The code is hosted on OpenStack's Git server. Bug reports and blueprints may be submitted to the python-openstackclient project on Launchpad. Code may be submitted to the openstack/python-openstackclient project using Gerrit. Developers may also be found in the IRC channel #openstack-sdks.

Indices and Tables

  • genindex
  • modindex
  • search