Ruff linter + pre-commit integration

[juanitorduz]

Closes #139

In addition, we move to https://pre-commit.ci/ to check the code style.

I took most of the code from the pymc repo ;)

[juanitorduz]

@aloctavodia I think one is ready for review. Please take a careful look because some changes were made automatically by Ruff. For more info on the options and config you can, of course, ask me ;) Or look into the pymc PR pymc-devs/pymc#7091 where there were many useful discussions :D

[juanitorduz]

Hehe! I forgot to add pylint. I am on it 😅

[juanitorduz]

ok! All 🟢 !

[aloctavodia]

Is this right? Does Ruff also takes care of type hints?

[juanitorduz]

No, but I am passing everything to the pre-commit hook: see https://results.pre-commit.ci/run/github/534281694/1706217149.DTa7osJdTE-SvRWjeQDG2Q It is still in

https://github.com/juanitorduz/pymc-bart/blob/18554ab35a4dbfce8bd74278fbffa2cb216c8d71/.pre-commit-config.yaml#L21-#L27

with the specific version

[aloctavodia]

ohhh!!!

[aloctavodia]

LGTM. I think, we should probably use this for other projects too!

[aloctavodia]

After this is merged what is the contribution workflow? What do I need to run locally? I realized we should list the steps here https://github.com/pymc-devs/pymc-bart/blob/main/CONTRIBUTING.md @PabloGGaray

[juanitorduz]

After this is merged what is the contribution workflow? What do I need to run locally? I realized we should list the steps here https://github.com/pymc-devs/pymc-bart/blob/main/CONTRIBUTING.md @PabloGGaray

True! I will add the steps on the PR. For reference: the pre-commit should take care of everything.

1. Install pre-commit

pip install pre-commit

2. Set up pre-commit

pre-commit install

3. Run the complete pre-commit hook to check specific files:

pre-commit run --files pymc_bart/tree.py

or all files:

pre-commit run --all-files

Once you commit something the pre-commit hook will run all the checks

You can skip this (for example when is WIP) by adding a flag (-n means no-verify)

git commit -m"my message" -n

One can, of course, install ruff in the Python environment to enable auto-format, but this is not necessary. The specific versions of ruff and mypy will be only specified in .pre-commit-config.yaml. It should be the only source of truth.

(I will add this to the guidelines)

[juanitorduz]

Guidelines added in a42c304

Maybe you try it from a fresh Python environment and see if it works for you?

Feedback is welcome!

[aloctavodia]

Thanks a lot @juanitorduz!