diff --git a/README.rst b/README.rst index 7c2ec9046..dce36e2dc 100644 --- a/README.rst +++ b/README.rst @@ -1,41 +1,28 @@ -================ -OpenStack Client -================ +=============== +OpenStackClient +=============== -OpenStack Client (aka ``python-openstackclient``) is a command-line client for -the OpenStack APIs. -It is primarily a wrapper to the stock python-\*client modules that implement the -actual REST API client actions. +OpenStackClient (aka OSC) is a command-line client for OpenStack that brings +the command set for Compute, Identity, Image, Object Store and Volume APIs +together in a single shell with a uniform command structure. -This is an implementation of the design goals shown in -`OpenStack Client Wiki`_. The primary goal is to provide -a unified shell command structure and a common language to describe -operations in OpenStack. The master repository is on GitHub_. +The primary goal is to provide a unified shell command structure and a common +language to describe operations in OpenStack. -.. _OpenStack Client Wiki: https://wiki.openstack.org/wiki/OpenStackClient -.. _GitHub: https://github.com/openstack/python-openstackclient +* `PyPi`_ - package installation +* `Online Documentation`_ +* `Launchpad project`_ - release management +* `Blueprints`_ - feature specifications +* `Bugs`_ - issue tracking +* `Source`_ +* License: Apache 2.0 -OpenStack Client has a plugin mechanism to add support for API extensions. - -* `Release management`_ -* `Blueprints and feature specifications`_ -* `Issue tracking`_ -* `PyPi`_ -* `Developer Docs`_ - -.. _release management: https://launchpad.net/python-openstackclient -.. _Blueprints and feature specifications: https://blueprints.launchpad.net/python-openstackclient -.. _Issue tracking: https://bugs.launchpad.net/python-openstackclient .. _PyPi: https://pypi.python.org/pypi/python-openstackclient -.. _Developer Docs: http://docs.openstack.org/developer/python-openstackclient/ -.. _install virtualenv: tools/install_venv.py - -Note -==== - -OpenStackClient is considered to be beta release quality as of the 0.3 release; -no assurances are made at this point for ongoing compatibility in command forms -or output. We do not, however, expect any major changes at this point. +.. _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://git.openstack.org/cgit/openstack/python-openstackclient Getting Started =============== @@ -44,19 +31,6 @@ OpenStack Client can be installed from PyPI using pip:: pip install python-openstackclient -Developers can use the `install virtualenv`_ script to create the virtualenv:: - - python tools/install_venv.py - source .venv/bin/activate - python setup.py develop - -Unit tests are now run using tox. The ``run_test.sh`` script provides compatibility -but is generally considered deprecated. - -The client can be called interactively by simply typing:: - - openstack - There are a few variants on getting help. A list of global options and supported commands is shown with ``--help``:: @@ -72,26 +46,26 @@ Configuration ============= The CLI is configured via environment variables and command-line -options as listed in https://wiki.openstack.org/wiki/OpenStackClient/Authentication. +options as listed in http://docs.openstack.org/developer/python-openstackclient/authentication.html. -The 'password flow' variation is most commonly used:: +Authentication using username/password is most commonly used:: export OS_AUTH_URL= export OS_PROJECT_NAME= - export OS_USERNAME= + export OS_USERNAME= export OS_PASSWORD= # (optional) The corresponding command-line options look very similar:: --os-auth-url --os-project-name - --os-username + --os-username [--os-password ] If a password is not provided above (in plaintext), you will be interactively prompted to provide one securely. -The token flow variation for authentication uses an already-acquired token +Authentication may also be performed using an already-acquired token and a URL pointing directly to the service API that presumably was acquired from the Service Catalog:: @@ -102,29 +76,3 @@ The corresponding command-line options look very similar:: --os-token --os-url - -Additional command-line options and their associated environment variables -are listed here:: - - --debug # turns on some debugging of the API conversation - --verbose | -v # Increase verbosity of output. Can be repeated. - --quiet | -q # suppress output except warnings and errors - --help | -h # show a help message and exit - -Building Documentation -====================== - -This documentation is written by contributors, for contributors. - -The source is maintained in the ``doc/source`` folder using -`reStructuredText`_ and built by `Sphinx`_ - -.. _reStructuredText: http://docutils.sourceforge.net/rst.html -.. _Sphinx: http://sphinx.pocoo.org/ - -Building Manually:: - - cd doc - make html - -Results are in the ``build/html`` directory.