openstack
/
osc-lib
Code Issues Proposed changes
OpenStackClient plugin library support
1,427 Commits
12 Branches
62 Tags
4.1 MiB
Python 100%
 
Go to file
OpenStack Release Bot 32b640f3c0 Update master for stable/2023.2 
Add file to the reno documentation build to show release notes for
stable/2023.2.

Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/2023.2.

Sem-Ver: feature
Change-Id: Ic489db56a8ec5699dcc77640763542e55de45e83
 		2023-09-07 09:49:34 +00:00
doc remove unicode prefix from code 2022-08-30 05:37:18 +00:00
osc_lib Fix comment of auth_config_hook 2023-08-19 17:48:05 +09:00
releasenotes Update master for stable/2023.2 2023-09-07 09:49:34 +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
.zuul.yaml tox 4 compatibility 2023-02-16 10:26:15 +00:00
HACKING.rst Remove Python 3 guide in HACKING 2022-09-27 17:40:49 +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
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 setup.cfg: Replace dash-separated config 2023-03-29 12:38:03 +01: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 tox 4 compatibility 2023-02-16 10:26:15 +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