openstack/python-openstackclient
Code Issues Proposed changes
Client for OpenStack services
16 Commits 6 Branches 61 Tags 72 MiB
Python 100%
3c7350b3c9
Go to file
Bhuvan Arumugam 3c7350b3c9 Auto generate AUTHORS for python-openstackclient. 
Bug: 976267

Now that git commits are gated by CLA, we shouldn't enforce
committers to add an entry in AUTHORS file. The AUTHORS file
should be generated automatically, based on git commits.

This commit fixes the problem.

* AUTHORS
  Remove this file.

* tests/test_authors.py
  Remove this test case.

* .gitignore
  Add AUTHORS file.

* openstackclient/openstack/common/setup.py
  generate_authors(): New method to create AUTHORS file. If
  AUTHORS.in file exists, append it's content to AUTHORS file.

* setup.py
  Import the new method.
  Generate AUTHORS file before creating the package.

Change-Id: Ia5488a43f88e13a0fb1f7a5d8d10a576b9034dc8
2012-05-01 16:31:23 -07:00
docs Adding name to Authors and updating a bad URL. More to get my gerrit workflow up. 2012-05-01 15:49:18 -07:00
openstackclient Auto generate AUTHORS for python-openstackclient. 2012-05-01 16:31:23 -07:00
tests Auto generate AUTHORS for python-openstackclient. 2012-05-01 16:31:23 -07:00
tools Add openstack-common and test infrastructure. 2012-04-28 22:27:34 +00:00
.gitignore Auto generate AUTHORS for python-openstackclient. 2012-05-01 16:31:23 -07:00
.gitreview Add openstack-common and test infrastructure. 2012-04-28 22:27:34 +00:00
LICENSE First commit 2012-04-18 13:16:39 -05:00
MANIFEST.in Add openstack-common and test infrastructure. 2012-04-28 22:27:34 +00:00
openstack-common.conf Add openstack-common and test infrastructure. 2012-04-28 22:27:34 +00:00
README.rst Add token auth to shell and README 2012-04-27 11:49:15 -05:00
run_tests.sh Add openstack-common and test infrastructure. 2012-04-28 22:27:34 +00:00
setup.cfg Add openstack-common and test infrastructure. 2012-04-28 22:27:34 +00:00
setup.py Auto generate AUTHORS for python-openstackclient. 2012-05-01 16:31:23 -07:00
tox.ini Add openstack-common and test infrastructure. 2012-04-28 22:27:34 +00:00

README.rst

OpenStack Client

python-openstackclient is a unified command-line client for the OpenStack APIs. It is a thin wrapper to the stock python-*client modules that implement the actual REST API client actions.

This is an implementation of the design goals shown in http://wiki.openstack.org/UnifiedCLI. The primary goal is to provide a unified shell command structure and a common language to describe operations in OpenStack.

python-openstackclient is designed to add support for API extensions via a plugin mechanism

Configuration

The cli is configured via environment variables and command-line options as listed in http://wiki.openstack.org/UnifiedCLI/Authentication.

The 'password flow' variation is most commonly used:

export OS_AUTH_URL=<url-to-openstack-identity>
export OS_TENANT_NAME=<tenant-name>
export OS_USERNAME=<user-name>
export OS_PASSWORD=<password>    # yes, it isn't secure, we'll address it in the future

The corresponding command-line options look very similar:

--os-auth-url <url>
--os-tenant-name <tenant-name>
--os-username <user-name>
--os-password <password>

The token flow variation for authentication uses an already-aquired token and a URL pointing directly to the service API that presumably was acquired from the Service Catalog:

export OS_TOKEN=<token>
export OS_URL=<url-to-openstack-service>

The corresponding command-line options look very similar:

--os-token <token>
--os-url <url-to-openstack-service>

Additional command-line options and their associated environment variables are listed here:

--debug             # turns on some debugging of the API conversation
                      (via httplib2)
--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