write docs & tie up loose ends re: linting + formatting

[schlich]

are you using a formatter for these is it in a pre-commit hook or something? if not can we put a little about it in the readme so we don't have reformat stuff a bunch?

(I feel like someone mentioned adding precommit hooks in one of the meetings but now I forget sorry)

Originally posted by @swoopej in #11 (comment)

Yes long story short i've been putting off documenting/finalizing code on a linter and formatter but the long and short of it is that we'll be using ruff. Key pages in the doc are config (ours will be in pyproject.yaml) and VS code integration