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.
Dean Troyer 5a9501be4f Updates for OpenDev transition 4 weeks ago
doc Updates for OpenDev transition 4 weeks ago
osc_lib Allow use of user-id as well as username for authentication 3 months ago
releasenotes Update master for stable/stein 2 months ago
.coveragerc Rename to osc-lib 3 years ago
.gitignore Updates for stestr 1 year ago
.gitreview OpenDev Migration Patch 1 month ago
.mailmap Clean up test environment and remove unused imports. 6 years ago
.stestr.conf Updates for stestr 1 year ago
.testr.conf Begin moving bits to osc_lib 3 years ago
.zuul.yaml add python 3.7 unit test job 2 months ago
HACKING.rst Update the documentation link for doc migration 1 year ago
README.rst Updates for OpenDev transition 4 weeks ago
lower-constraints.txt Stop processing requests verify args 10 months ago
requirements.txt Stop processing requests verify args 10 months ago
setup.cfg Change openstack-dev to openstack-discuss 5 months ago Updated from global requirements 2 years ago
test-requirements.txt Updated from global requirements 1 year ago
tox.ini Updates for OpenDev transition 4 weeks ago



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 (
  • 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
  • ->

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