OpenStackClient plugin library support
Go to file
Dean Troyer a0d9746eb5 format_dict() returns no value for None
We have some subtle cases to distinguish:
* value of None   (the Python literal)
* value of ''     (an empty string)
* value of 'None' (a string)

Return no representation of data when the value is the Python literal None
rather than the string 'None' which can be confused for an actual string value.

Returning an empty string ('') can be confused for an actual empty
string so that is also not an option.  By leaving off the quotes we can accurately
reflect the distinct value of None.

Change-Id: Icdc1712e626a7e8a706348586a6be2e7612c4376
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2019-09-02 09:45:03 -05:00
doc Updates for OpenDev transition 2019-04-20 13:22:25 -05:00
osc_lib format_dict() returns no value for None 2019-09-02 09:45:03 -05:00
releasenotes Handle nested dicts in format_dict() 2019-08-31 00:02:47 -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 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
.testr.conf Begin moving bits to osc_lib 2016-05-12 16:07:24 -05:00
.zuul.yaml Add Python 3 Train unit tests 2019-07-05 14:19:59 -04: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 Updates for OpenDev transition 2019-04-20 13:22:25 -05:00
lower-constraints.txt Stop processing requests verify args 2018-07-11 05:26:19 +00:00
requirements.txt Stop processing requests verify args 2018-07-11 05:26:19 +00:00
setup.cfg Add Python 3 Train unit tests 2019-07-05 14:19:59 -04: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 Add Python 3 Train unit tests 2019-07-05 14:19:59 -04: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