DEVELOPMENT.md

March 6, 2023 · View on GitHub

Requirements

Install nix to setup adhoc development environment.

Start new shell:

nix-shell

We are using bazel as a build system. I also provided a tools/bazel script to make it easier to use.

Build the extension:

./tools/bazel run extensions

To run all format, it is most convenient to use treefmt:

nix-shell --command treefmt

Otherwise run black, isort, and ruff

Whispercpp also use pyright for Python type check. To run it do:

./tools/bazel run //:pyright

Testing

Run tests:

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

NOTE: Make sure to include the extern/whispercpp, extern/pybind11/include, and $(python3-config --prefix)/include/python3 in your CPLUS_INCLUDE_PATH so that clangd can find the headers in your editor.