Skip to content

Development

This page covers local development for the bubseek repository.

Setup

From the repository root:

uv sync
make install

make install creates the virtual environment, installs dependencies, and installs pre-commit hooks.

Common commands

Command Description
make install Install dependencies and pre-commit hooks.
make check Run lock verification, linting, formatting checks, and type checks.
make test Run pytest.
make build Build the wheel and source distribution.
make docs Serve documentation locally.
make docs-test Build documentation and fail on warnings.

Testing

make test

Or directly:

uv run pytest tests

Building

make build

The wheel includes builtin skills from skills/. The source files for those builtin skills live in src/skills/.

Docs

make docs
make docs-test

Contributing

See CONTRIBUTING.md.