Skip to main content

Audio Annotation Tool

Project description

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
  1. Navigate to the backend directory and install dependencies:
cd whombat/back
uv sync
  1. Start the development server:
make serve-dev

or

WHOMBAT_DEV=true uv run python -m whombat

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

whombat-0.8.8.tar.gz (7.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

whombat-0.8.8-py3-none-any.whl (8.1 MB view details)

Uploaded Python 3

File details

Details for the file whombat-0.8.8.tar.gz.

File metadata

  • Download URL: whombat-0.8.8.tar.gz
  • Upload date:
  • Size: 7.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for whombat-0.8.8.tar.gz
Algorithm Hash digest
SHA256 dadaf91d80e2c53a29f930da34152ffea49b001cf5f9a1184ade061ce7cb846a
MD5 3e46faea5ff8d28bd9bed99c0a9159be
BLAKE2b-256 eb6a9523208fa3cf17a842ea78d68e4179fcdde45519456da1c55b449afd2df9

See more details on using hashes here.

Provenance

The following attestation bundles were made for whombat-0.8.8.tar.gz:

Publisher: publish.yml on mbsantiago/whombat

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file whombat-0.8.8-py3-none-any.whl.

File metadata

  • Download URL: whombat-0.8.8-py3-none-any.whl
  • Upload date:
  • Size: 8.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for whombat-0.8.8-py3-none-any.whl
Algorithm Hash digest
SHA256 08b717741099807826f7ae920e5947d9c8e17ce4fcc9bf9dd88408ddaefabe54
MD5 73773310f147c6ab90c84317466637c9
BLAKE2b-256 cfbf4d47f4ec72b3f059e0d85bad8e9472001e01da745380e65c3a13a8f02078

See more details on using hashes here.

Provenance

The following attestation bundles were made for whombat-0.8.8-py3-none-any.whl:

Publisher: publish.yml on mbsantiago/whombat

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page