implement linting and formatting process

[hutch3232]

Description

I would recommend ruff (https://docs.astral.sh/ruff/). I've been using it for about 2 years and really like it. Very fast, ergonomic, solid tooling (has GitHub Actions). Same creators as uv which this project uses.

Could use this issue to decide on which rules to enforce, should the idea be accepted.

Do you have any additional supporting notes?

Previously suggested in a comment here: #621 (comment)

I'd be happy to contribute to this implementation. I made a small related change already here: #650

[kennethshsu]

HI @hutch3232, this has been brought up a few times already, and I think the consensus is that we do not want to use a linter at the project level on here. I personally use black, and I think some others use their own favorites.

[genedan]

@hutch3232 would you be willing to do a demo of Ruff in one of our sessions? I've become a uv convert after seeing it adopted here, so I'm interested in trying Ruff, even if not being enforced across the whole project, at least locally or maybe in other projects.

Right now I just use the built-in code inspections in my IDE. It mostly does a good job, but it does miss the more ambiguous guidelines in PEPs or maybe some internal team/project conventions that may be outside the PEPs. For example, I noticed we might be missing some things in PEP 257.

[hutch3232]

Absolutely. I won't be able to attend Friday's (May 22) but probably could present it at the next one if there is time for me. I love uv as well. I've gotten most of my colleagues hooked on it too.