Introduce Ruff

[glatterf42]

Please confirm that this PR has done the following:

• [ ] Tests Added But updated black CI workflow
• Documentation Added
• Name of contributors Added to AUTHORS.rst
• Description in RELEASE_NOTES.md Added

Description of PR

As suggested by #820 (comment), this PR cherry-picks the commits from #820 that refer to ruff and amends some of them that got mixed with Python mentions.

[glatterf42]

Should we add some mention of ruff to the docs?

Also, in ixmp4, we have an optional dependency group called "dev" in pyproject.toml and that includes a minimum version for ruff. Should we add something similar here?

[danielhuppmann]

Should we add some mention of ruff to the docs?

Please also add the badge to index.rst, should be sufficient.

Also, in ixmp4, we have an optional dependency group called "dev" in pyproject.toml and that includes a minimum version for ruff. Should we add something similar here?

Yes, please.

[phackstock]

Looks quite good overall, a few small comments in line. Maybe you could mention ruff the PULL_REQUEST_TEMPLATE.md or CONTRIBUTING.rst

[phackstock]

Just so that I understand it correctly, we will now have a setup.cfg, setup.py and pyproject.toml?
Could you combine everything into a pyproject.toml or move the ruff settings to setup.cfg or setup.py?

[phackstock]

Seems that you can also use a ruff.toml or .ruff.toml file (https://github.com/astral-sh/ruff?tab=readme-ov-file#configuration). I'd prefer that.

[glatterf42]

Yes, ruff won't read configuration from setup.cfg or setup.py. My intention with using pyproject.toml was to next use #823 to migrate to poetry, which will read all settings from pyproject.toml, so that way the files will be combined. Let me clean up this PR as per your suggestions and then create one with poetry and then we can decide: if you don't like poetry, I can migrate the settings here to ruff.toml.

[phackstock]

I see your point. I'd prefer though if you use ruff.toml for now and then in a future PR integrate setup.cfg and setup.py into one pyproject.toml.

[danielhuppmann]

You also have to use the ruff-badge in docs/index.rst on line 8.

[danielhuppmann]

Looks good to me, thank you!

[codecov]

Codecov Report

Attention: Patch coverage is 99.36709% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 94.8%. Comparing base (10933de) to head (079d345).

Files	Patch %	Lines
pyam/run_control.py	66.6%	1 Missing ⚠️

Additional details and impacted files

@@          Coverage Diff          @@
##            main    #821   +/-   ##
=====================================
  Coverage   94.8%   94.8%           
=====================================
  Files         64      64           
  Lines       6089    6092    +3     
=====================================
+ Hits        5775    5778    +3     
  Misses       314     314           

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

[phackstock]

Good to merge from my side if you change the pyproject.toml to ruff.toml

[glatterf42]

I can't merge it myself though, don't have permissions for that, so please go ahead.