OpenStackClient plugin library support
![]() cliff has a concept of FormattableColumn which allows CLI implementors to convert data into human-readable format only when a human-readable format is requested and keep data unconverted for manchine-readable formats like JSON or YAML. Deprecation warnings is now emitted in favor of using FormattableColumn. Partially implement blueprint osc-formattable-columns Change-Id: Ia55bc950ecfc666d4a957507beab98eef74390aa Related-Bug: #1687955 |
||
---|---|---|
doc | ||
osc_lib | ||
releasenotes | ||
tools | ||
.coveragerc | ||
.gitignore | ||
.gitreview | ||
.mailmap | ||
.testr.conf | ||
HACKING.rst | ||
LICENSE | ||
README.rst | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
test-requirements.txt | ||
tox.ini |
osc-lib
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