Install Buildarr as a Python application#

Buildarr is written in Python, and can be installed as a standard Python application using pip. In the latest release, Python 3.8 or later is required.

As Buildarr uses a plugin architecture to implement its integrations with *Arr stack applications, Buildarr is split into multiple Python packages:

• buildarr (also known as Buildarr Core), the base package that implements the buildarr command.
• Plugin packages for managing different types of applications:
  • buildarr-sonarr, the Buildarr plugin for the Sonarr PVR for TV shows.
  • buildarr-radarr, the Buildarr plugin for the Radarr PVR for movies.
  • buildarr-prowlarr, the Buildarr plugin for the Prowlarr indexer manager.
  • buildarr-jellyseerr, the Buildarr plugin for the Jellyseerr media request manager.

When installing Buildarr using Docker or the Windows installer, these packages are bundled together, so no additional installation is usually necessary.

Documented below are recommended methods for installing and using Buildarr as a native Python application.

pipx#

The easiest way to install and update Buildarr as a native Python application on a machine is to use pipx.

First, run pipx install to install the Buildarr base package.

pipx install buildarr

Now use pipx inject to install individual plugins you'd like to use.

pipx inject buildarr buildarr-sonarr buildarr-radarr buildarr-prowlarr[sonarr,radarr] buildarr-jellyseerr[sonarr,radarr]

pipx will have installed Buildarr in your local user's execution environment (~/.local/bin). If the execution environment is in your PATH, the buildarr command will now be usable.

buildarr --help

To update Buildarr and any installed plugins to the latest versions, use the pipx upgrade command.

pipx upgrade --include-injected buildarr

Virtual Environment#

Buildarr can be installed to, and used from, a Python virtual environment.

This is useful for isolating Buildarr from your host system, or installing the command to a non-privileged path.

First, create the virtual environment, using either the built-in venv module, or the third-party virtualenv command.

python3 -m venv buildarr-venv

Activate the virtual environment to run Python commands within the virtual environment context.

Using Bash or compatible shells:

. buildarr-venv/bin/activate

On Windows (using Command Prompt):

buildarr-venv\bin\activate.bat

Install Buildarr and any required plugins using pip. (The below command will also update Buildarr and plugins to their latest versions, if already installed.)

python -m pip install --upgrade buildarr buildarr-sonarr buildarr-radarr buildarr-prowlarr[sonarr,radarr] buildarr-jellyseerr[sonarr,radarr]

Once installed, you will be able to run the buildarr command within the virtual environment.

buildarr --help