openstack
/
osc-lib
Code Issues Proposed changes
OpenStackClient plugin library support
1,383 Commits 11 Branches 72 Tags 4.2 MiB
Python 100%
Go to file
OpenStack Release Bot b44c3c7749 Update .gitreview for unmaintained/wallaby 
Change-Id: I370ab2e607a0ec7bec639f22941a4fea31ab1629
 		2024-03-07 08:45:04 +00:00
doc Switch to newer openstackdocstheme and reno versions 2020-05-31 20:42:26 +02:00
osc_lib Replace 'assertFalse(a in b)' with 'assertNotIn(a, b)' 2020-11-06 10:26:20 +00:00
releasenotes Update master for stable/victoria 2020-09-08 12:22:10 +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/wallaby 2024-03-07 08:45:04 +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:30:44 +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 Merge "requirements: Drop os-testr" 2020-09-23 07:54:08 +00:00
requirements.txt Remove commandmanager subclass 2020-06-10 19:10:20 -05:00
setup.cfg bump py37 to py38 in tox.ini 2020-09-18 11:54:44 +08:00
setup.py Cleanup py27 support 2020-04-05 17:39:59 +02:00
test-requirements.txt Fix lower-constraints job 2021-01-11 10:35:42 +00:00
tox.ini Update TOX_CONSTRAINTS_FILE for stable/wallaby 2021-03-19 13:13:35 +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