openstack/osc-lib
Code Issues Proposed changes
OpenStackClient plugin library support
1,429 Commits 12 Branches 73 Tags 4.3 MiB
Python 100%
923a847dea
Go to file
Dr. Jens Harbott 923a847dea 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.

Change-Id: Ic2ddb04bc1f1e81586fff54f1e7bee9ee3689512
2024-03-01 14:49:02 +01: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 Add 'SizeColumn' formatter 2023-03-29 12:38:02 +01: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/2023.2 2023-09-07 09:49:31 +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-01 14:49:02 +01: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
lower-constraints.txt Merge "requirements: Drop os-testr" 2020-09-23 07:54:08 +00: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 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 Update TOX_CONSTRAINTS_FILE for stable/2023.2 2023-09-07 09:49:32 +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