Skip to content

Conversation

@alanking
Copy link
Collaborator

Addresses #310

Test suite passed.

Please have a look at the config file and see whether there are any tweaks we want to make. The one shown is the default, but we can modify it and point the workflows at it.


Some thoughts:

I didn't do very much work to apply these fixes. Ruff did most of it itself. The GitHub Actions workflow uses --diff, so it will not modify anything in PRs. I might update the README to include a tidbit about running Ruff locally because that was incredibly easy as well. I just ran the docker container as described here: https://docs.astral.sh/ruff/installation

Here's what running the check (linter) looks like:

docker run -v .:/io --rm ghcr.io/astral-sh/ruff check --fix

I included --unsafe-fixes as well to try to fix everything and then combed through the changes and fixed what didn't quite work out the way it should have. You can of course just use --diff to only display a diff like in GitHub Actions.

And here's what running the formatter looks like:

docker run -v .:/io --rm ghcr.io/astral-sh/ruff format

I consider this a forerunner to using Ruff in the python-irodsclient (https://github.com/irods/python-irodsclient) repo. We can try it out here to see if we like it, and, if so, we can apply it there as well.

The Ruff TOML configuration file reflects the default Ruff configuration.
We can adjust this according to our preferences.
Includes --unsafe-fixes as well as manual intervention.
@alanking
Copy link
Collaborator Author

alanking commented Nov 19, 2025

You can see the GitHub Actions workflow results over in a test PR I made in my fork: alanking#1 Not sure why they won't run here - guess it's different because it's not my repo.

EDIT: And here's what it looks like if the problems aren't gone: alanking#2

@alanking
Copy link
Collaborator Author

alanking commented Dec 9, 2025

Converting to draft until irods/python-irodsclient#726 is a bit further along. We will want to do something similar if not identical in this repo.

@alanking alanking marked this pull request as draft December 9, 2025 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant