DEVELOPING.md

Developing

Getting Started

This project requires:

• python (>= 3.7)
• pip (>= 22.2)
• poetry (>= 1.2): see installation instructions

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

# get basic project tooling
make bootstrap

# get a persistent virtual environment to work within
poetry shell

# install project dependencies
poetry install

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

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

To jump into a poetry-managed virtualenv run poetry shell, this will prevent the need for poetry run... prefix for each command.

Developing

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

poetry shell
pip uninstall yardstick  #... if you already have yardstick installed in this virtual env
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