openstack
/
osc-lib
Code Issues Proposed changes
OpenStackClient plugin library support
1,364 Commits 11 Branches 72 Tags 4.2 MiB
Python 100%
Go to file
OpenStack Release Bot 4d153ff6c8 Update .gitreview for unmaintained/victoria 
Change-Id: I966428b18af80bac9027a9efda7e6911e15b327f
 		2024-03-07 08:43:57 +00:00
doc Switch to newer openstackdocstheme and reno versions 2020-05-31 20:42:26 +02:00
osc_lib Merge "Fix the misspelling of "argument"" 2020-06-12 17:00:32 +00:00
releasenotes Merge "Remove commandmanager subclass" 2020-06-12 14:58:08 +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 Update .gitreview for unmaintained/victoria 2024-03-07 08:43:57 +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
.zuul.yaml Drop master-only job from zuul config 2024-03-05 11:31:16 +01: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 Fix l-c testing for ubuntu focal 2020-11-05 14:16:58 +00:00
requirements.txt Remove commandmanager subclass 2020-06-10 19:10:20 -05:00
setup.cfg Cleanup py27 support 2020-04-05 17:39:59 +02:00
setup.py Cleanup py27 support 2020-04-05 17:39:59 +02:00
test-requirements.txt Switch to newer openstackdocstheme and reno versions 2020-05-31 20:42:26 +02:00
tox.ini Update TOX_CONSTRAINTS_FILE for stable/victoria 2020-09-08 12:22:07 +00: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