openstack
/
osc-lib
Code Issues Proposed changes
OpenStackClient plugin library support
1,413 Commits 11 Branches 71 Tags 4.2 MiB
Python 100%
Go to file
Dr. Jens Harbott 4b1808da48 Drop master-only job from zuul config 
The tips job should only run on the master branch, drop it from the zuul
config for stable branches.

Updated for zed and older: Drop openstack-lower-constraints-jobs

Change-Id: Ic2ddb04bc1f1e81586fff54f1e7bee9ee3689512
(cherry picked from commit 923a847dea)
 		2024-03-05 09:15:26 +01:00
doc Switch to newer openstackdocstheme and reno versions 2020-05-31 20:42:26 +02:00
osc_lib Do not output log on bash autocomplete generation 2022-05-10 12:52:15 -04:00
releasenotes doc: Comment out language option 2022-06-07 00:35:38 +09: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 stable/zed 2022-09-09 11:21:34 +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 09:15:26 +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 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 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/zed 2022-09-09 11:21:36 +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