Add GitHub Action for Python code formatter

[korydraughn]

The goal of the GitHub action is to report when the Python code needs to be formatted.

It should behave like https://github.com/irods/irods/blob/878d648082bd5b888c0f8d518dd22f4d8e4a06f1/.github/workflows/linter-irods-clang-format.yml.

[SwooshyCueb]

Given that black has opinions we don't agree with, I'm not sure this is a good idea.

[korydraughn]

Updated to allow room for picking a formatter.

[alanking]

If we change formatters, we might have to have another "astyle" commit. See #615.

Ruff has also been discussed as it seems to be a popular choice (although, IIRC, it uses Black for its formatter).

[SwooshyCueb]

When writing the userspace packager for icommands, I used flakehell with pylint, pydocstyle, and a bunch of flake8 plugins for linting: https://github.com/irods/irods_client_icommands/blob/main/packaging/userspace/pyproject.toml

When I get around to updating the userspace packager, I'll be surveying the current landscape to see what might be best for us, as flakehell is no longer maintained, and last I checked, flakeheaven is on life support, if memory serves.

[alanking]

Just noting that we've already formatted the codebase here: a0b0966 We can obviously do it again with a different formatter and we haven't really been policing it since then, but just thought that would be worth pointing out.

[alanking]

I know we are still debating this, but just wanted to point out a POC I put up over in the ingest tool that might be interesting as it relates to our discussion: irods/irods_capability_automated_ingest#311

[d-w-moore]

ruff is a superset of Black?