Linting

Linting your code

For linting, we currently make use of both ruff and black.

These are used to ensure we produce readable, maintainable, and more consistent code.

To quickly run both linters, simply run this bash script. The -f flag is called to run an automatic fix with ruff. If you simply wish for ruff to print the errors it finds to the console, remove this flag.

source scripts/lint.sh -f  # with the fix flag

source scripts/lint.sh  # without

Alternatively, you can run ruff and black separately from a terminal instance.

For black, you need to run: black .

and ruff requires: ruff --fix . for automatic fixes and error printouts or ruff --show-source . for a more thorough breakdown.