openstack
/
python-openstackclient
Code Issues Proposed changes
Client for OpenStack services
3,143 Commits 10 Branches 45 Tags 69 MiB
Python 100%
Go to file
Huanxuan Ao 4a8b802d6b Refactor volume unit test with FakeVolume class in volume v1 
FakeVolume class has been added in the fake.py in
volume v1, this patch refactors the volume command
unit tests with the FakeVolume class.

Change-Id: Ic3c1a46d5bff9048d0095f5739ae9e5a34ca6b5b
 		2016-09-21 15:33:37 +08:00
doc Merge "Add --description to Create/Set Network" 2016-09-20 06:55:29 +00:00
examples osc-lib: api.auth 2016-06-30 08:57:59 -05:00
openstackclient Refactor volume unit test with FakeVolume class in volume v1 2016-09-21 15:33:37 +08:00
releasenotes Merge "Fix openstack quota set/show --class not work" 2016-09-20 09:01:16 +00:00
tools Cleanup after install 2016-08-28 08:48:23 +02:00
.coveragerc Change ignore-errors to ignore_errors 2015-09-21 14:54:21 +00:00
.gitignore gitignore .idea 2016-02-20 16:25:56 +08:00
.gitreview Add openstack-common and test infrastructure. 2012-04-28 22:27:34 +00:00
.mailmap Clean up test environment and remove unused imports. 2013-01-22 11:44:18 -06:00
.testr.conf move unit tests to new "unit" test module 2016-09-08 15:19:50 -07:00
CONTRIBUTING.rst Added CONTRIBUTING.rst file 2016-05-16 17:42:48 +05:30
HACKING.rst Remove non-existing hacking deviations from doc 2015-08-09 13:22:48 -07:00
LICENSE Remove LICENSE APPENDIX 2015-11-18 13:25:56 +09:00
README.rst Added a note on how to test changes 2016-07-07 16:11:54 +00:00
babel.cfg Add translation markers for user v2 actions 2014-10-09 14:47:19 -04:00
requirements.txt Updated from global requirements 2016-09-01 18:50:33 +00:00
setup.cfg Trivial: Rename ListTransferRequests to ListTransferRequest 2016-09-12 10:44:54 +08:00
setup.py Updated from global requirements 2015-09-18 16:42:31 +00:00
test-requirements.txt Updated from global requirements 2016-08-31 09:14:50 +00:00
tox.ini move all functional tests to tests module 2016-09-09 03:29:47 +00:00

README.rst

OpenStackClient

Latest Version

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

Getting Started

OpenStack Client can be installed from PyPI using pip:

pip install python-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 help server create

If you want to make changes to the OpenStackClient for testing and contribution, make any changes and then run:

python setup.py develop

or:

pip install -e .

Configuration

The CLI is configured via environment variables and command-line options as listed in http://docs.openstack.org/developer/python-openstackclient/authentication.html.

Authentication using username/password is most commonly used:

export OS_AUTH_URL=<url-to-openstack-identity>
export OS_PROJECT_NAME=<project-name>
export OS_USERNAME=<username>
export OS_PASSWORD=<password>  # (optional)

The corresponding command-line options look very similar:

--os-auth-url <url>
--os-project-name <project-name>
--os-username <username>
[--os-password <password>]

If a password is not provided above (in plaintext), you will be interactively prompted to provide one securely.

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:

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>