-
Notifications
You must be signed in to change notification settings - Fork 3.1k
fix: Align pyproject.toml with contribution guide #1975
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
fix: Align pyproject.toml with contribution guide #1975
Conversation
| "pandas>=2.0.0", | ||
| ] | ||
|
|
||
| [dependency-groups] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I dont think this is right...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR fixes a developer setup issue where the installation command documented in CONTRIBUTING.md would fail due to a mismatch in dependency group definitions. The fix moves dev and docs dependency groups from [dependency-groups] to [project.optional-dependencies] to make them accessible via the --extra flag in uv pip install commands, and adds the missing pre-commit package to the dev group.
Key Changes:
- Moved
devanddocsgroups from[dependency-groups]to[project.optional-dependencies]to enable--extraflag usage - Added
pre-commitpackage to thedevdependency group
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
pyproject.toml
Outdated
| "nbconvert>=7.14.2", | ||
| "docutils!=0.21" | ||
| "docutils!=0.21", | ||
| "pre-commit", |
Copilot
AI
Jan 7, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The pre-commit package should include a version specification for consistency with other dependencies in this file. All other dev dependencies specify minimum versions (e.g., pytest>=7.2.2, tox>=4.11.4). Consider adding a version constraint like "pre-commit>=3.0.0" to ensure compatibility and prevent potential breaking changes from future versions.
| "pre-commit", | |
| "pre-commit>=3.0.0", |
|
Closing since there is a change to the actual upstream version... |
Description
This PR fixes a bug in the developer setup process where the installation command from the
CONTRIBUTING.mdguide would fail.The failure was caused by a mismatch between the dependency group definitions in
pyproject.tomland the--extraflags used in the guide's command. This change aligns thepyproject.tomlfile with the documentation by moving thedevanddocsdependency groups to[project.optional-dependencies]and adds the missingpre-commitpackage to thedevgroup.This ensures a smooth setup experience for new contributors.
Closes #1970
Type of change
How has this change been tested, please provide a testcase or example of how you tested the change?
I have tested the change by following the steps to reproduce the bug:
uv pip install -r pyproject.toml --extra dev --extra docs --extra metrics.Any specific deployment considerations
None.
Docs