Table of Contents
### Prerequisites
WIP
Use uv to sync dependencies:
uv syncSee CONTRIBUTING.md for details.
Run the following command to install the pre-commit hook:
uv sync
pre-commit install --config .github/hooks/.pre-commit-config.yaml --hook-type pre-commit --install-hooks --overwriteUse Ruff for linting and formatting:
uvx ruff check
uvx ruff formatUse Ty for type checking:
uvx ty check
# In watch mode
uvx ty check --watchRun tests with pytest:
uv run pytest --cov=hyperbench --cov-report=term-missing
# html report
uv run pytest --cov=hyperbench --cov-report=htmlBefore committing code, run the following command to ensure code quality:
uv pip uninstall . && \
uv sync && \
uv pip install -e . && \
uv run ruff format && \
uvx ty check && \
uv run pytest --cov=hyperbench --cov-report=term-missingWIP
WIP