IAMconsortium / pyam

Analysis & visualization of energy & climate scenarios
https://pyam-iamc.readthedocs.io/
Apache License 2.0
220 stars 115 forks source link

Introduce Ruff #821

Closed glatterf42 closed 4 months ago

glatterf42 commented 4 months ago

Please confirm that this PR has done the following:

Description of PR

As suggested by https://github.com/IAMconsortium/pyam/pull/820#issuecomment-1971061133, this PR cherry-picks the commits from #820 that refer to ruff and amends some of them that got mixed with Python mentions.

glatterf42 commented 4 months ago

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 commented 4 months ago

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.

danielhuppmann commented 4 months ago

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

codecov[bot] commented 4 months ago

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 :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #821 +/- ## ===================================== Coverage 94.8% 94.8% ===================================== Files 64 64 Lines 6089 6092 +3 ===================================== + Hits 5775 5778 +3 Misses 314 314 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

glatterf42 commented 4 months ago

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