OpenStackClient plugin library support
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
Stephen Finucane 2b7a679a42
Fix lower-constraints job
2 years ago
doc Switch to newer openstackdocstheme and reno versions 3 years ago
osc_lib Replace 'assertFalse(a in b)' with 'assertNotIn(a, b)' 2 years ago
releasenotes Update master for stable/victoria 3 years ago
.coveragerc Rename to osc-lib 7 years ago
.gitignore Updates for stestr 6 years ago
.gitreview OpenDev Migration Patch 4 years ago
.mailmap Clean up test environment and remove unused imports. 10 years ago
.stestr.conf Updates for stestr 6 years ago
.zuul.yaml Add Python3 wallaby unit tests 2 years ago
HACKING.rst Update the documentation link for doc migration 6 years ago
LICENSE Remove LICENSE APPENDIX 7 years ago
README.rst Updates for OpenDev transition 4 years ago
lower-constraints.txt Merge "requirements: Drop os-testr" 3 years ago
requirements.txt Remove commandmanager subclass 3 years ago
setup.cfg bump py37 to py38 in tox.ini 3 years ago
setup.py Cleanup py27 support 3 years ago
test-requirements.txt Fix lower-constraints job 2 years ago
tox.ini Fix lower-constraints job 2 years ago

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