Skip to main content

A toolkit for whisper.cpp with audio processing and model management

Project description

WhisperCPP Kit

A wrapper arround whisper.cpp with additional helper features like model management capabilities.

While whispercpp_kit will automatically build and set up whisper.cpp for you, it requires certain system-level dependencies (git, cmake, ffmpeg) to be pre-installed on your system. If any dependency is missing, the library will provide a clear error message indicating what needs to be installed.

System requirements

Before installing whispercpp_kit, ensure you have the following dependencies installed:

  • git
  • cmake
  • ffmpeg

Installing dependencies

Ubuntu/Debian:

sudo apt update
sudo apt install git cmake ffmpeg

MacOS:

brew install git cmake ffmpeg

Installation

pip install whispercpp_kit

Quickstart

from whispercpp_kit import WhisperCPP

whisper = WhisperCPP(model_name="tiny.en")
# whisper = Whisper(model_path="/custom/pathggml-large-v3-turbo-q5_0.bin")

output = whisper.transcribe("input.mp3")
print(output)

Docker example

See examples/docker/README.md for more details. You can run the container in two ways:

git clone https://github.com/s-emanuilov/whispercpp_kit
cd whispercpp_kit/examples/docker

docker build -t whispercpp_kit .

# Run with default model (base.en)
docker run -v $(pwd):/app/audio whispercpp_kit your_audio.mp3

# Using specific model (works with both mounting options)
docker run -v $(pwd):/app/audio whispercpp_kit your_audio.mp3 tiny.en

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

whispercpp_kit-0.1.2.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

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

whispercpp_kit-0.1.2-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

Details for the file whispercpp_kit-0.1.2.tar.gz.

File metadata

  • Download URL: whispercpp_kit-0.1.2.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for whispercpp_kit-0.1.2.tar.gz
Algorithm Hash digest
SHA256 7e22a71a2f25e4610cca0406aeb846f1f4a52248c1f4060516e7784a71c416c1
MD5 b50ff67c15aa651eafc0a9be66de4831
BLAKE2b-256 f7eb22e398414d638666fd4d7e4960d2d27510a2860553699b9aabcfc10f434d

See more details on using hashes here.

File details

Details for the file whispercpp_kit-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: whispercpp_kit-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for whispercpp_kit-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4cdf6c8dfb9073d45b8ea2b8271700faab980a9e81c1a5fdee4a582833695f4d
MD5 d78eddb6d71630d00f6505acc375cc0d
BLAKE2b-256 a632a29e531cea23c8faee209381a5f5ed83107978a4a7839189a7e8fc8a8d85

See more details on using hashes here.

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