Developing

Getting Started

This project requires:

Once you have python and uv installed, get the project bootstrapped:

# get basic project tooling
make tools

# install project dependencies
uv sync

Pre-commit is used to help enforce static analysis checks with git hooks:

uv run pre-commit install --hook-type pre-push

If you want to use a locally-editable copy of yardstick while you develop:

uv pip uninstall yardstick  #... if you already have yardstick installed in this virtual env
uv pip install -e .

To run all static-analysis and tests:

make

Or run them individually:

make static-analysis
make unit
make cli

If you want to see all of the things you can do:

make help