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.
Rui Chen 11b6e92d2d Util methods for column name backward compatibility 6 years ago
doc Fix a tiny typo in documentation 6 years ago
osc_lib Util methods for column name backward compatibility 6 years ago
releasenotes Update reno for stable/ocata 6 years ago
tools Add Constraints support 6 years ago
.coveragerc Rename to osc-lib 7 years ago
.gitignore gitignore .idea 7 years ago
.gitreview Rename to osc-lib 7 years ago
.mailmap Clean up test environment and remove unused imports. 10 years ago
.testr.conf Begin moving bits to osc_lib 7 years ago
HACKING.rst Remove non-existing hacking deviations from doc 7 years ago
LICENSE Remove LICENSE APPENDIX 7 years ago
README.rst Add release notes for 1.0 release 6 years ago
requirements.txt Updated from global requirements 6 years ago
setup.cfg Add Python 3.5 classifier and venv 6 years ago
setup.py Updated from global requirements 7 years ago
test-requirements.txt Updated from global requirements 6 years ago
tox.ini Add Constraints support 6 years ago

README.rst

osc-lib

Latest Version

Downloads

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