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.
Eric Fried fea31fb971 Add a release note for dropping py2 2 weeks ago
doc Updates for OpenDev transition 9 months ago
osc_lib Add enhance_help kwarg to tags option generators 2 months ago
releasenotes Add a release note for dropping py2 2 weeks ago
.coveragerc Rename to osc-lib 3 years ago
.gitignore Updates for stestr 2 years ago
.gitreview OpenDev Migration Patch 9 months ago
.mailmap Clean up test environment and remove unused imports. 7 years ago
.stestr.conf Updates for stestr 2 years ago
.testr.conf Begin moving bits to osc_lib 3 years ago
.zuul.yaml Drop python 2.7 support and testing 1 month ago
HACKING.rst Update the documentation link for doc migration 2 years ago
LICENSE Remove LICENSE APPENDIX 4 years ago
README.rst Updates for OpenDev transition 9 months ago
lower-constraints.txt Stop processing requests verify args 1 year ago
requirements.txt Stop processing requests verify args 1 year ago
setup.cfg Drop python 2.7 support and testing 1 month ago
setup.py Updated from global requirements 2 years ago
test-requirements.txt Updated from global requirements 1 year ago
tox.ini Drop python 2.7 support and testing 1 month 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