Installation

In order to develop Plugins for Horus, you should install the HorusAPI package in your python environment. This package contains the necessary classes and functions to interact with the Horus app. The installation of the package is not mandatory, as the plugins will run inside Horus, not your virtual environment. The main attractive of installing the HorusAPI is to be able to develop the plugins with type hints and code completion.

Main installation

You will need to download the latest release of HorusAPI from the releases page. You can also install HorusAPI directly from PyPI using pip:

pip install HorusAPI

Once installed, you can import the HorusAPI package into your Python application:

import HorusAPI

Note

To install from the releases page, perform the following command instead:

pip install <path to horusapi-x.x.x.whl>