OpenStackClient plugin library support
You cannot 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 db9cdc95ed setup.cfg: Replace dash-separated config
Resolve the following warnings like the following being issued when
building the package:

  UserWarning: Usage of dash-separated 'description-file' will not be
  supported in future versions. Please use the underscore name
  'description_file' instead

Change-Id: I4b75aac2c09b772f91e5ac9a4e77e9462f38bfd1
Signed-off-by: Stephen Finucane <>
2 months ago
doc remove unicode prefix from code 9 months ago
osc_lib Add 'SizeColumn' formatter 2 months ago
releasenotes Add 'SizeColumn' formatter 2 months 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 tox 4 compatibility 3 months ago
HACKING.rst Remove Python 3 guide in HACKING 8 months ago
README.rst Moving IRC network reference to OFTC 2 years ago
lower-constraints.txt Merge "requirements: Drop os-testr" 3 years ago
requirements.txt Remove commandmanager subclass 3 years ago
setup.cfg setup.cfg: Replace dash-separated config 2 months ago Cleanup py27 support 3 years ago
test-requirements.txt Fix lower-constraints job 2 years ago
tox.ini tox 4 compatibility 3 months 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 OFTC (
  • 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