openstack/osc-lib
Code Issues Proposed changes
OpenStackClient plugin library support
1,464 Commits 12 Branches 75 Tags 4.3 MiB
Python 100%
master
Go to file
Zuul d3fdae8095 Merge "ruff: Enable pyupgrade rules"
2024-09-12 18:46:40 +00:00
doc ruff: Enable pyupgrade rules 2024-09-12 17:55:08 +01:00
osc_lib Merge "ruff: Enable pyupgrade rules" 2024-09-12 18:46:40 +00:00
releasenotes ruff: Enable pyupgrade rules 2024-09-12 17:55:08 +01:00
.coveragerc Exclude tests directory from coverage calculation 2024-08-23 06:28:58 +00:00
.git-ignore-blame-revs Ignore black changes 2023-11-15 10:06:17 +00: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
.pre-commit-config.yaml ruff: Enable pyupgrade rules 2024-09-12 17:55:08 +01:00
.stestr.conf Updates for stestr 2017-09-14 16:53:57 -05:00
.zuul.yaml zuul: Use openstack-python3-jobs template 2024-02-29 17:35:28 +01:00
HACKING.rst Fix pre-commit issues 2023-08-30 19:29:30 +01:00
LICENSE Remove LICENSE APPENDIX 2015-11-18 13:25:56 +09:00
pyproject.toml ruff: Enable pyupgrade rules 2024-09-12 17:55:08 +01:00
README.rst Moving IRC network reference to OFTC 2021-07-08 08:23:42 -05:00
requirements.txt Drop dependency on simplejson 2024-05-20 09:58:37 +09:00
setup.cfg Drop formal support for Python 3.6, 3.7 2023-08-25 14:31:19 +01:00
setup.py Blacken code 2023-11-15 10:05:52 +00:00
test-requirements.txt Fix lower-constraints job 2021-01-11 10:35:42 +00:00
tox.ini pre-commit: Migrate from flake8 to ruff 2024-09-12 14:18:17 +01: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 OFTC (irc.oftc.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