OpenStackClient plugin library support
Go to file
Dean Troyer ed8ef0df9f Tell ClientManager when auth is required
Commands that do not reuire authentication still call things that want
to check the service catalog; no auth means no service catalog.
(I'm looking at you OSC's is_networking_enabled())  Get more aggressive
at not doing auth when it is not required.

The cost of this is commands with auth_required=False need to be more
selective about what they do with ClientManager.auth_ref as it will
now happily return None when auth is not required _and_ no credentials
are present, rather than throw up all over the place.

Change-Id: I72ae6154268bdf26be6054c0fef6a4c67c71119c
2017-04-25 07:27:17 -05:00
doc Fix a tiny typo in documentation 2016-09-29 20:40:34 +09:00
osc_lib Tell ClientManager when auth is required 2017-04-25 07:27:17 -05:00
releasenotes Add MultiKeyValueCommaAction to osc-lib 2017-04-18 21:46:38 -05:00
tools Add Constraints support 2016-12-21 12:46:56 +11:00
.coveragerc Rename to osc-lib 2016-05-12 16:06:15 -05:00
.gitignore gitignore .idea 2016-02-20 16:25:56 +08: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
.testr.conf Begin moving bits to osc_lib 2016-05-12 16:07:24 -05:00
HACKING.rst Remove non-existing hacking deviations from doc 2015-08-09 13:22:48 -07:00
LICENSE Remove LICENSE APPENDIX 2015-11-18 13:25:56 +09:00
README.rst Add release notes for 1.0 release 2016-08-04 11:16:54 -05:00
requirements.txt Updated from global requirements 2017-04-12 04:19:50 +00:00
setup.cfg The python 3.5 is added 2017-03-08 11:45:33 +05:30
setup.py Updated from global requirements 2017-03-07 02:04:21 +00:00
test-requirements.txt Updated from global requirements 2017-02-10 05:57:24 +00:00
tox.ini The python 3.5 is added 2017-03-08 11:45:33 +05:30

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