Metadata-Version: 2.1
Name: osc-lib
Version: 2.8.0
Summary: OpenStackClient Library
Home-page: https://docs.openstack.org/osc-lib/latest/
Author: OpenStack
Author-email: openstack-discuss@lists.openstack.org
License: UNKNOWN
Project-URL: Bug Tracker, https://storyboard.openstack.org/#!/project/openstack/osc-lib
Project-URL: Documentation, https://docs.openstack.org/osc-lib/latest/
Project-URL: Source Code, https://opendev.org/openstack/osc-lib/
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: OpenStack
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.6
Requires-Dist: cliff (>=3.2.0)
Requires-Dist: keystoneauth1 (>=3.14.0)
Requires-Dist: openstacksdk (>=0.15.0)
Requires-Dist: oslo.i18n (>=3.15.3)
Requires-Dist: oslo.utils (>=3.33.0)
Requires-Dist: pbr (!=2.1.0,>=2.0.0)
Requires-Dist: simplejson (>=3.5.1)
Requires-Dist: stevedore (>=1.20.0)

=======
osc-lib
=======

.. image:: https://img.shields.io/pypi/v/osc-lib.svg
    :target: https://pypi.org/project/osc-lib/
    :alt: 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

.. _PyPi: https://pypi.org/project/osc-lib
.. _Online Documentation: http://docs.openstack.org/osc-lib/latest/
.. _Launchpad project: https://launchpad.net/python-openstackclient
.. _Bugs: https://storyboard.openstack.org/#!/project_group/80
.. _Source: https://opendev.org/openstack/osc-lib
.. _Developer: http://docs.openstack.org/project-team-guide/project-setup/python.html
.. _Contributing: http://docs.openstack.org/infra/manual/developers.html
.. _Testing: http://docs.openstack.org/osc-lib/latest/contributor/#testing
.. _Release Notes: https://docs.openstack.org/releasenotes/osc-lib

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