Skip to content

Installation

The package is published on PyPI and can be installed with pip (or any equivalent):

Bash
1
pip install uiprotect

To use the command-line interface (the uiprotect console script), install the cli extra, which pulls in typer:

Bash
1
pip install "uiprotect[cli]"

uiprotect supports Python 3.11+.

Next, see the usage page to see how to use it. If you plan to talk to the documented Public Integration API (API-key authentication), the usage page covers when to prefer it over the private API.