openstack/osc-lib
Code Issues Proposed changes
OpenStackClient plugin library support
1,094 Commits 12 Branches 75 Tags 4.3 MiB
Python 100%
dd42094f06
Go to file
Jenkins dd42094f06 Merge "Updated from global requirements"
2016-10-06 18:47:59 +00:00
doc Fix a tiny typo in documentation 2016-09-29 20:40:34 +09:00
osc_lib Mask passwords in debug logs for auth_config_hook 2016-10-05 21:17:39 -04:00
releasenotes standardize release note page ordering 2016-09-07 17:02:21 -04: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 2016-10-06 17:00:57 +00:00
setup.cfg Add Python 3.5 classifier and venv 2016-07-18 14:36:30 +08:00
setup.py Updated from global requirements 2015-09-18 16:42:31 +00:00
test-requirements.txt Updated from global requirements 2016-09-30 10:23:02 +00:00
tox.ini Add reno for osc-lib release notes management 2016-07-29 13:04:25 +08: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