chore: Add ruff dependency and configuration

[ecalifornica]

edited description by @jsstevenson:

close #3

• Add Ruff formatting and linting. Remove flake8, isort, black, pylint, bandit -- Ruff can cover these bases pretty well.
• Update pre-commit hooks to perform checks for both Ruff linting and formatting
• Update cqa makefile target to do the same (just check), and reformat target to actually format.

Specific rule groupings selected (note that many specific rules also include auto-fixability -- so while they're nitpicky, they're also self-executing):

• F, E, W: the ~rough equivalent of base Flake8
• I: isort
• N: Pep8 naming. Rules for variable names. https://docs.astral.sh/ruff/rules/#pep8-naming-n
• UP: PyUpgrade. Flags cases where newer Python versions have introduced features intended to replace what's been flagged. https://docs.astral.sh/ruff/rules/#pyupgrade-up
• YTT: proper usage of sys.version https://docs.astral.sh/ruff/rules/#flake8-2020-ytt
• S: flake8-bandit, flags security issues https://docs.astral.sh/ruff/rules/#flake8-bandit-s
• B: flake8-bugbear, flags common error-prone practices like using a multi-char string as an arg to .strip() or mutable collections as default args https://docs.astral.sh/ruff/rules/#flake8-bugbear-b
• A: flag variables that shadow builtins # https://docs.astral.sh/ruff/rules/#flake8-builtins-a
• C4: best practices for comprehensions https://docs.astral.sh/ruff/rules/#flake8-comprehensions-c4
• DTZ: best practice for datetimes # https://docs.astral.sh/ruff/rules/#flake8-datetimez-dtz
• EM: don't provide literals to exceptions. I'm 50/50 on this one. https://docs.astral.sh/ruff/rules/#flake8-errmsg-em
• LOG: logger best practices https://docs.astral.sh/ruff/rules/#flake8-logging-log
• G: logger formatting best practices https://docs.astral.sh/ruff/rules/#flake8-logging-format-g
• PIE: catch a few kinds of redundant or repetitive statements https://docs.astral.sh/ruff/rules/#flake8-pie-pie
• PT: pytest best practices # https://docs.astral.sh/ruff/rules/#flake8-pytest-style-pt
• RSE: raise MyError() -> raise MyError https://docs.astral.sh/ruff/rules/#flake8-raise-rse
• RET: unnecessary/superfluous return/other kinds of control flow things # https://docs.astral.sh/ruff/rules/#flake8-return-ret
• SIM: simplify various kinds of compound statements (most autofixable) # https://docs.astral.sh/ruff/rules/#flake8-simplify-sim
• ARG: unused args # https://docs.astral.sh/ruff/rules/#flake8-unused-arguments-arg
• PTH: force use of pathlib. This will entail # https://docs.astral.sh/ruff/rules/#flake8-use-pathlib-pth
• PL: lots of pylint rules # https://docs.astral.sh/ruff/rules/#pylint-pl
• TRY: best practices around try/catch # https://docs.astral.sh/ruff/rules/#tryceratops-try
• PERF: some pretty simple performance goofs # https://docs.astral.sh/ruff/rules/#perflint-perf
• RUF: custom rules original to Ruff. There's some interesting stuff here. https://docs.astral.sh/ruff/rules/#ruff-specific-rules-ruf

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (9aa8d98) to head (5078419).
Report is 31 commits behind head on main.

❗ Current head 5078419 differs from pull request most recent head cd9e9e6

Please upload reports for the commit cd9e9e6 to get more accurate results.

Additional details and impacted files

@@            Coverage Diff            @@
##              main       #36   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines           18        18           
=========================================
  Hits            18        18           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[github-actions]

This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

[github-actions]

This PR was closed because it has been stalled for 7 days with no activity.

[reece]

This issue was closed by stalebot. It has been reopened to give more time for community review. See biocommons coding guidelines for stale issue and pull request policies. This resurrection is expected to be a onos.environ["GITHUB_TOKEN"]e-time event.

[github-actions]

This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

[jsstevenson]

I'd add one thought here, in addition to my comment in #3 : Ruff development moves very quickly, and new rules are opted-in by default, which can cause headaches in CI (eg an aesthetic change like touching up the docs can fail because new code checks have been introduced). For this reason, we pin an exact Ruff version and have a policy of revisiting it about every 6 months.

[github-actions]

This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

[github-actions]

This PR was closed because it has been stalled for 7 days with no activity.

[jsstevenson]

There's some room for discussion about particular Ruff rules/configs. Experimentally, I think PTH (here) will take the most work to implement, although I think it's worth it in the long run.

Note: I'm not totally sure how to handle testing of the boilerplate code contained here -- I noqa'd it for now?

[jsstevenson]

Other notes: I've left off two linting groups, flake8-annotations and flake8-pydocstyle because I think they'd be a big lift to achieve compliance with. Worth eventually implementing IMO.

[korikuzma]

@biocommons/maintainers did anyone else want to review this before it gets merged in?