OpenStackClient plugin library support
Go to file
Dr. Jens Harbott 7689c38f3f zuul: Use openstack-python3-jobs template
Switch to the generic template that will be update each cycle.

Change-Id: I16ff153d8b949d9c17e6592ecfc005ec3187a872
2024-02-29 17:35:28 +01:00
doc Blacken code 2023-11-15 10:05:52 +00:00
osc_lib Blacken code 2023-11-15 10:05:52 +00:00
releasenotes reno: Update master for unmaintained/yoga 2024-02-05 16:14:09 +00:00
.coveragerc Rename to osc-lib 2016-05-12 16:06:15 -05:00
.git-ignore-blame-revs Ignore black changes 2023-11-15 10:06:17 +00: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
.pre-commit-config.yaml pre-commit: Integrate black 2023-11-15 10:05:52 +00:00
.stestr.conf Updates for stestr 2017-09-14 16:53:57 -05:00
.zuul.yaml zuul: Use openstack-python3-jobs template 2024-02-29 17:35:28 +01:00
HACKING.rst Fix pre-commit issues 2023-08-30 19:29:30 +01:00
LICENSE Remove LICENSE APPENDIX 2015-11-18 13:25:56 +09:00
README.rst Moving IRC network reference to OFTC 2021-07-08 08:23:42 -05:00
requirements.txt Remove commandmanager subclass 2020-06-10 19:10:20 -05:00
setup.cfg Drop formal support for Python 3.6, 3.7 2023-08-25 14:31:19 +01:00
setup.py Blacken code 2023-11-15 10:05:52 +00:00
test-requirements.txt Fix lower-constraints job 2021-01-11 10:35:42 +00:00
tox.ini tox: Use pre-commit for style checks 2023-11-15 10:06:18 +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 OFTC (irc.oftc.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