OpenStackClient plugin library support
Go to file
Monty Taylor a269e27d49 Run OSC unit test tips jobs
Recently we broke the osc unittest tips jobs with a change to osc-lib.
We already have jobs and a project-template for osc-tox-unit-tips, so
add them to osc-lib jobs.

Depends-On: https://review.openstack.org/580898
Change-Id: Ie5a7285f884d1dc612b5d121ad47dd47864bb2e2
2018-07-09 14:16:57 +00:00
doc Trivial: Update pypi url to new url 2018-04-20 17:05:16 +07:00
osc_lib Use openstack.config for config and Session objects 2018-07-05 08:30:32 -05:00
releasenotes Use openstack.config for config and Session objects 2018-07-05 08:30:32 -05:00
.coveragerc Rename to osc-lib 2016-05-12 16:06:15 -05:00
.gitignore Updates for stestr 2017-09-14 16:53:57 -05:00
.gitreview Rename to osc-lib 2016-05-12 16:06:15 -05:00
.mailmap Clean up test environment and remove unused imports. 2013-01-22 11:44:18 -06:00
.stestr.conf Updates for stestr 2017-09-14 16:53:57 -05:00
.testr.conf Begin moving bits to osc_lib 2016-05-12 16:07:24 -05:00
.zuul.yaml Run OSC unit test tips jobs 2018-07-09 14:16:57 +00:00
HACKING.rst Update the documentation link for doc migration 2017-07-26 16:11:31 +00:00
LICENSE Remove LICENSE APPENDIX 2015-11-18 13:25:56 +09:00
README.rst Trivial: Update pypi url to new url 2018-04-20 17:05:16 +07:00
lower-constraints.txt Use openstack.config for config and Session objects 2018-07-05 08:30:32 -05:00
requirements.txt Use openstack.config for config and Session objects 2018-07-05 08:30:32 -05:00
setup.cfg Update the documentation link for doc migration 2017-07-26 16:11:31 +00:00
setup.py Updated from global requirements 2017-03-07 02:04:21 +00:00
test-requirements.txt Updated from global requirements 2018-02-17 10:05:38 +00:00
tox.ini Use openstack.config for config and Session objects 2018-07-05 08:30:32 -05:00

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