Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move test, bench, and doc requirements out of pyproject.toml #1407

Merged
merged 9 commits into from
Sep 26, 2024

Conversation

gadomski
Copy link
Member

@gadomski gadomski commented Sep 22, 2024

Description:

I've had some discussion with folks (cc @jkeifer) that have pointed me in the direction of not including development dependencies as optional-dependencies. This PR moves test and bench out to a requirements-dev.txt, and the doc dependencies to docs/requirements.txt.

This will make it easier to:

  • Keep the dev dependnecies frozen, e.g. via uv pip compile
  • Avoid folks installing w/ dev dependencies when they enable all optional dependencies (e.g. with uv pip install --all-extras

PR Checklist:

  • pre-commit hooks pass locally
  • Tests pass (run scripts/test)
  • Documentation has been updated to reflect changes, if applicable
  • This PR maintains or improves overall codebase code coverage.
  • Changes are added to the CHANGELOG. See the docs for information about adding to the changelog.

This makes them easier to:

- Freeze (using `uv pip compile`)
- Avoid building in the case where all optional dependencies are enabled
@gadomski gadomski self-assigned this Sep 22, 2024
Copy link

codecov bot commented Sep 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.20%. Comparing base (87e1a24) to head (dc09c7d).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1407   +/-   ##
=======================================
  Coverage   91.20%   91.20%           
=======================================
  Files          52       52           
  Lines        7239     7239           
  Branches     1019     1019           
=======================================
  Hits         6602     6602           
  Misses        457      457           
  Partials      180      180           

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

@gadomski gadomski added this to the v1.11 milestone Sep 23, 2024
Copy link
Member

@jsignell jsignell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me! Just one typo 😝

Just wondering: are you thinking that we should move away from the scripts to rule them all model?

docs/contributing.rst Outdated Show resolved Hide resolved
Co-authored-by: Julia Signell <[email protected]>
@gadomski
Copy link
Member Author

Just wondering: are you thinking that we should move away from the scripts to rule them all model?

I personally don't love "scripts to rule them all" for libraries, I find they increase maintenance burden without much benefit. I think they're more useful for applications, when you have more resources to manage during development.

E.g. when I see scripts/test in some repo's contribution instructions, I have to go read that file (or the project's dependencies) to see what test tool we're running. But if the instructions say "run pytest", that's simpler IMO 😄.

@gadomski gadomski added this pull request to the merge queue Sep 26, 2024
Merged via the queue into main with commit 461242b Sep 26, 2024
20 checks passed
@gadomski gadomski deleted the general-cleanup branch September 26, 2024 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants