====================
python-octaviaclient
====================

.. image:: https://governance.openstack.org/tc/badges/python-octaviaclient.svg

Octavia client for OpenStack Load Balancing

This is an OpenStack Client (OSC) plugin for Octavia, an OpenStack
Load Balancing project.

For more information about Octavia see:
https://docs.openstack.org/octavia/latest/

For more information about the OpenStack Client see:
https://docs.openstack.org/python-openstackclient/latest/

* Free software: Apache license
* Documentation: https://docs.openstack.org/python-octaviaclient/latest/
* Source: https://opendev.org/openstack/python-octaviaclient
* Release notes: https://docs.openstack.org/releasenotes/python-octaviaclient/
* Bugs: https://bugs.launchpad.net/octavia

Getting Started
===============

.. note:: This is an OpenStack Client plugin. The ``python-openstackclient``
          project should be installed to use this plugin.

.. note:: This project is only intended to be used for the OpenStack Client
          CLI. The `openstacksdk <https://opendev.org/openstack/openstacksdk>`_
          should be used for python bindings.

Octavia client can be installed from PyPI using pip

.. code-block:: bash

    pip install python-octaviaclient

If you want to make changes to the Octavia client for testing and contribution,
make any changes and then run

.. code-block:: bash

    python setup.py develop

or

.. code-block:: bash

    pip install -e .
