openstack/osc-lib
Code Issues Proposed changes
OpenStackClient plugin library support
1,368 Commits 12 Branches 75 Tags 4.3 MiB
Python 100%
4bb55ce75d
Go to file
Stephen Finucane 4bb55ce75d formatters: Cast columns before outputting 
Libraries like 'novaclient' return non-primitive types for many
operations. These are typically wrappers around primitive types, e.g.
'OrderedDict', but they all break YAML output formatting since PyYAML is
only compatible with primitive types when operating in safe mode.

The solution is rather simple: simply cast the values for these to their
expected format.

Change-Id: Ib7db6a25f2352a013cb2ce603e60ca48b6cc70e6
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Story: #2008320
Task: #41217
2020-11-04 15:30:09 +00:00
doc Switch to newer openstackdocstheme and reno versions 2020-05-31 20:42:26 +02:00
osc_lib formatters: Cast columns before outputting 2020-11-04 15:30:09 +00:00
releasenotes Update master for stable/victoria 2020-09-08 12:22:10 +00: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 OpenDev Migration Patch 2019-04-19 19:42:29 +00: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
.zuul.yaml Add Python3 victoria unit tests 2020-04-10 14:15:54 +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
lower-constraints.txt Merge "requirements: Drop os-testr" 2020-09-23 07:54:08 +00:00
README.rst Updates for OpenDev transition 2019-04-20 13:22:25 -05:00
requirements.txt Remove commandmanager subclass 2020-06-10 19:10:20 -05:00
setup.cfg Cleanup py27 support 2020-04-05 17:39:59 +02:00
setup.py Cleanup py27 support 2020-04-05 17:39:59 +02:00
test-requirements.txt Fix hacking min version to 3.0.1 2020-10-12 16:44:17 +08:00
tox.ini Merge "bump py37 to py38 in tox.ini" 2020-10-31 05:09:14 +00:00

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