whispercpp Python Bindings

The project uses bazel as its build system. You can use the provided tools/bazel script to build the extensions:

./tools/bazel run extensions

Execute tests located in the tests/ and examples/ directories using Bazel:

./tools/bazel test tests/... examples/...

Install the necessary Python dependencies for this example using pip:

pip install -r requirements.txt

For local development or custom builds, first initialize the submodules. You can then build the wheel using either pypa/build or bazel, and install the resulting wheel.

# Initialize submodules
git submodule update --init --recursive

# Option 1: using pypa/build
python3 -m build -w
pip install dist/*.whl

# Option 2: using bazel
./tools/bazel build //:whispercpp_wheel
pip install $(./tools/bazel info bazel-bin)/*.whl

Use the provided build_bento.py script to package the Whisper service into a Bento. You can use the --override flag to overwrite an existing Bento.

# Build the bento
python build_bento.py

# Build and override existing bento
python build_bento.py --override

Once the Bento is built, use the BentoML CLI to create a container image for the whispercpp_asr service.

bentoml containerize whispercpp_asr

To set up an adhoc development environment, install nix and enter a new shell using the following command:

nix-shell

You can install the prebuilt package using pip. For platforms without prebuilt wheels, a hermetic toolchain will be used during installation, which may take longer. Use the -vv flag to monitor progress.

To install the latest version directly from the GitHub repository, use the following command:

# Standard installation
pip install whispercpp

# Install latest version from source
pip install git+https://github.com/aarnphm/whispercpp.git -vv

To run the pyright Python type checker, use the Bazel wrapper script:

./tools/bazel run //:pyright

To build the project locally, first initialize all submodules:

git submodule update --init --recursive

Then, you can build the wheel using one of two methods:

Option 1: Using pypa/build

python3 -m build -w

Option 2: Using Bazel

./tools/bazel build //:whispercpp_wheel

After building, install the resulting wheel:

Via pypa/build:

pip install dist/*.whl

Via Bazel:

pip install $(./tools/bazel info bazel-bin)/*.whl

The most convenient way to run all formatters is via treefmt using nix-shell. Alternatively, you can run black, isort, and ruff manually.

nix-shell --command treefmt

You can install the whispercpp package using pip.

pip install whispercpp