Installation¶

Requirements¶

Python 3.11 or newer (tested on 3.11, 3.12, and 3.13)
behave >= 1.2.6 (installed automatically as a dependency)

behave-trace has minimal runtime dependencies — only behave. The viewer uses only Python stdlib (http.server, json, pathlib). It is pure Python, fully typed (mypy --strict clean), and works on Linux, macOS, and Windows.

Optional extras¶

Extra	Install command	Description
`dev`	`pip install behave-trace[dev]`	pytest, ruff, mypy, build, pre-commit
`docs`	`pip install behave-trace[docs]`	mkdocs, mkdocs-material, mkdocstrings
`watch`	`pip install behave-trace[watch]`	watchdog for `--watch` mode

From PyPI¶

The recommended way to install behave-trace:

pip install behave-trace

To upgrade:

pip install --upgrade behave-trace

With pipx (isolated environment)¶

pipx install behave-trace

With uv¶

uv pip install behave-trace

From source¶

git clone https://github.com/MathiasPaulenko/behave-trace.git
cd behave-trace
pip install .

Development install¶

For contributors who want to run tests, linting, and pre-commit hooks:

git clone https://github.com/MathiasPaulenko/behave-trace.git
cd behave-trace
pip install -e ".[dev]"
pre-commit install

The [dev] extra installs pytest, pytest-cov, pytest-timeout, ruff, mypy, build, and pre-commit.

Verify the installation¶

behave-trace --version

1.0.0

You can also verify the Python API is importable:

python -c "import behave_trace; print(behave_trace.__version__)"

Uninstall¶

pip uninstall behave-trace