============
Installation
============

You can install the package from PyPI:

.. code-block:: bash

    pip install unifi-controller-api

Development Installation
------------------------

For development, you'll want to install the development dependencies:

.. code-block:: bash

    pip install unifi-controller-api[dev]

Or clone the repository and install locally:

.. code-block:: bash

    git clone https://github.com/tnware/unifi-controller-api.git
    cd unifi-controller-api
    pip install -e ".[dev]"

Documentation Dependencies
--------------------------

To build the documentation, install the documentation dependencies:

.. code-block:: bash

    pip install unifi-controller-api[docs]

Or if you've cloned the repository:

.. code-block:: bash

    pip install -e ".[docs]"