openstack
/
osc-lib
Code Issues Proposed changes
OpenStackClient plugin library support
1,034 Commits 11 Branches 72 Tags 4.2 MiB
Python 100%
Go to file
Steve Martinelli cfcb8b097a trivial whitespace change to kick off docs publishing 
we need another commit to kick off developer docs at:
  http://docs.openstack.org/developer/osc-lib

Change-Id: Iccd04cd4af29affc67810482bc264285c312c609
 		2016-07-14 17:19:37 -04:00
doc update the transition docs 2016-06-23 16:39:40 +00:00
osc_lib Merge "Generate auth plugin options based on the name" 2016-07-11 13:35:12 +00:00
.coveragerc Rename to osc-lib 2016-05-12 16:06:15 -05:00
.gitignore gitignore .idea 2016-02-20 16:25:56 +08: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 trivial whitespace change to kick off docs publishing 2016-07-14 17:19:37 -04:00
requirements.txt Updated from global requirements 2016-07-09 19:25:39 +00:00
setup.cfg Rename to osc-lib 2016-05-12 16:06:15 -05:00
setup.py Updated from global requirements 2015-09-18 16:42:31 +00:00
test-requirements.txt Remove tempest from test-requirements.txt 2016-07-06 09:31:32 +02:00
tox.ini Begin moving bits to osc_lib 2016-05-12 16:07:24 -05: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

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