openstack
/
osc-lib
Code Issues Proposed changes
OpenStackClient plugin library support
1,325 Commits 11 Branches 72 Tags 4.2 MiB
Python 100%
Go to file
Zuul 84c38a8615 Merge "Add enhance_help kwarg to tags option generators" 2020-01-13 21:55:04 +00:00
doc Updates for OpenDev transition 2019-04-20 13:22:25 -05:00
osc_lib Add enhance_help kwarg to tags option generators 2019-11-15 14:15:39 -06:00
releasenotes Merge "Add KeyValueAppendAction to osc-lib" 2019-11-04 22:31:06 +00:00
.coveragerc Rename to osc-lib 2016-05-12 16:06:15 -05:00
.gitignore Updates for stestr 2017-09-14 16:53:57 -05:00
.gitreview OpenDev Migration Patch 2019-04-19 19:42:29 +00:00
.mailmap Clean up test environment and remove unused imports. 2013-01-22 11:44:18 -06:00
.stestr.conf Updates for stestr 2017-09-14 16:53:57 -05:00
.testr.conf Begin moving bits to osc_lib 2016-05-12 16:07:24 -05:00
.zuul.yaml Drop python 2.7 support and testing 2019-12-27 16:07:06 +08: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 Updates for OpenDev transition 2019-04-20 13:22:25 -05:00
lower-constraints.txt Stop processing requests verify args 2018-07-11 05:26:19 +00:00
requirements.txt Stop processing requests verify args 2018-07-11 05:26:19 +00:00
setup.cfg Drop python 2.7 support and testing 2019-12-27 16:07:06 +08:00
setup.py Updated from global requirements 2017-03-07 02:04:21 +00:00
test-requirements.txt Updated from global requirements 2018-02-17 10:05:38 +00:00
tox.ini Drop python 2.7 support and testing 2019-12-27 16:07:06 +08:00

README.rst

osc-lib

Latest Version

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