Whombat 0.8.3

Audio Annotation Tool

Whombat - Python Backend

whombat is an open-source web-based audio annotation tool designed to facilitate audio data labeling and annotation, with a special focus on aiding machine learning model development.

For additional details on installing the entire application and its usage, refer to the main README.

For the latest updates and detailed documentation, check out the official documentation.

Installation

With Pip

The most straightforward method to set up the backend and Whombat Python API is using pip. Execute the following command:

pip install whombat

From Source Code

Clone the repository:

git clone https://github.com/mbsantiago/whombat.git

Install the package:

cd whombat/backend
pip install .

With Docker

Run Whombat inside a Docker container. Build the container by cloning the repository and executing:

git clone https://github.com/mbsantiago/whombat.git
docker build -t whombat .

Once the build is complete, run the container with:

docker run -p 5000:5000 whombat

Development Environment

We manage Whombat's development with uv.

1. Follow the official installation instructions to get uv on your machine.

2. Clone the repository:

git clone https://github.com/mbsantiago/whombat.git

3. Navigate to the backend directory and install dependencies:

cd whombat/back
uv sync

4. Start the development server:

make serve-dev

or

WHOMBAT_DEV=true uv run python -m whombat