openstack
/
osc-lib
Code Issues Proposed changes
OpenStackClient plugin library support
1,175 Commits 11 Branches 72 Tags 4.3 MiB
Python 100%
Go to file
Doug Hellmann 5b80552b11 turn on warning-is-error for sphinx 
Update a docstring that had an rst formatting error and then turn on the
warning-is-error flag to prevent future issues with documentation.

Change-Id: I29fc90a2eb1599c9da88489415a9e080d88cc707
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
 		2017-06-22 14:38:17 -04:00
doc rearrange existing documentation to fit the new standard layout 2017-06-22 14:36:41 -04:00
osc_lib turn on warning-is-error for sphinx 2017-06-22 14:38:17 -04:00
releasenotes Add MultiKeyValueCommaAction to osc-lib 2017-04-18 21:46:38 -05:00
tools Add Constraints support 2016-12-21 12:46:56 +11:00
.coveragerc Rename to osc-lib 2016-05-12 16:06:15 -05:00
.gitignore rearrange existing documentation to fit the new standard layout 2017-06-22 14:36:41 -04:00
.gitreview Rename to osc-lib 2016-05-12 16:06:15 -05:00
.mailmap Clean up test environment and remove unused imports. 2013-01-22 11:44:18 -06:00
.testr.conf Begin moving bits to osc_lib 2016-05-12 16:07:24 -05:00
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 Add release notes for 1.0 release 2016-08-04 11:16:54 -05:00
requirements.txt Updated from global requirements 2017-05-23 11:57:41 +00:00
setup.cfg turn on warning-is-error for sphinx 2017-06-22 14:38:17 -04:00
setup.py Updated from global requirements 2017-03-07 02:04:21 +00:00
test-requirements.txt Updated from global requirements 2017-05-23 11:57:41 +00:00
tox.ini The python 3.5 is added 2017-03-08 11:45:33 +05:30

README.rst

osc-lib

Latest Version

Downloads

OpenStackClient (aka OSC) is a command-line client for OpenStack. osc-lib is a package of common support modules for writing OSC plugins.

  • PyPi - package installation
  • Online Documentation
  • Launchpad project - part of OpenStackClient
  • 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

osc-lib can be installed from PyPI using pip:

pip install osc-lib

Transition From OpenStackclient

This library was extracted from the main OSC repo after the OSC 2.4.0 release. The following are the changes to imports that will cover the majority of transition to using osc-lib:

  • openstackclient.api.api -> osc_lib.api.api
  • openstackclient.api.auth -> osc_lib.api.auth
  • openstackclient.api.utils -> osc_lib.api.utils
  • openstackclient.common.command -> osc_lib.command.command
  • openstackclient.common.commandmanager -> osc_lib.command.commandmanager
  • openstackclient.common.exceptions -> osc_lib.exceptions
  • openstackclient.common.logs -> osc_lib.logs
  • openstackclient.common.parseractions -> osc_lib.cli.parseractions
  • openstackclient.common.session -> osc_lib.session
  • openstackclient.common.utils -> osc_lib.utils
  • openstackclient.i18n -> osc_lib.i18n
  • openstackclient.shell -> osc_lib.shell

Also, some of the test fixtures and modules may be used:

  • openstackclient.tests.fakes -> osc_lib.tests.fakes
  • openstackclient.tests.utils -> osc_lib.tests.utils