Skip to content

Installation

Prerequisites

Before installing AudioBackend, make sure you have:

  • Python 3.7 or higher
  • pip package manager

Virtual Environment

It's recommended to use a virtual environment:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

Installation Methods

From PyPI

The recommended way to install AudioBackend:

pip install audiobackend

From Source

For the latest development version:

git clone https://github.com/Niamorro/audiobackend.git
cd audiobackend
pip install -e .

Development Installation

For contributing or development:

pip install -e .[dev]

System Dependencies

sudo apt update
sudo apt install libportaudio2 libportaudiocpp0 portaudio19-dev
sudo dnf install portaudio-devel
sudo pacman -S portaudio
brew install ffmpeg portaudio

FFmpeg is included in the PyAV package. For PortAudio, it's included in the sounddevice package.

Troubleshooting

Common Issues

ImportError: No module named 'av'

This usually means PyAV installation failed. Try:

pip install --upgrade av

PortAudio not found

Install the PortAudio development package for your system (see System Dependencies above)

Version conflicts
pip install --upgrade pip
pip install --upgrade audiobackend

Getting Help

If you encounter any issues:

  1. Check the GitHub Issues
  2. Create a new issue with:
    • Your Python version
    • Your operating system
    • The complete error message
    • Steps to reproduce