openstack
/
osc-lib
Code Issues Proposed changes
OpenStackClient plugin library support
1,198 Commits 11 Branches 72 Tags 4.2 MiB
Python 100%
Go to file
OpenStack Release Bot ef967cbeba Update UPPER_CONSTRAINTS_FILE for feature/osc4 
Change-Id: I0ad62803e09126d0896e040087cfcc14138d1be3
 		2017-07-31 19:09:33 +00:00
doc use openstackdocstheme html context 2017-06-23 14:51:31 -04:00
osc_lib Emit warnings to encourage cliff FormattableColumn 2017-07-08 21:18:04 +00:00
releasenotes Update reno for stable/pike 2017-07-28 21:04:26 +00: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 Update .gitreview for feature/osc4 2017-07-31 19:09:32 +00: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 Update the documentation link for doc migration 2017-07-26 16:11:31 +00:00
LICENSE Remove LICENSE APPENDIX 2015-11-18 13:25:56 +09:00
README.rst update links to docs in readme 2017-06-22 15:02:02 -04:00
requirements.txt Updated from global requirements 2017-07-27 20:30:51 +00:00
setup.cfg Update the documentation link for doc migration 2017-07-26 16:11:31 +00:00
setup.py Updated from global requirements 2017-03-07 02:04:21 +00:00
test-requirements.txt Updated from global requirements 2017-07-27 20:30:51 +00:00
tox.ini Update UPPER_CONSTRAINTS_FILE for feature/osc4 2017-07-31 19:09:33 +00:00

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