Skip to content

Conversation

@ArnabTechiee
Copy link

Description

This PR fixes a bug in the developer setup process where the installation command from the CONTRIBUTING.md guide would fail.

The failure was caused by a mismatch between the dependency group definitions in pyproject.toml and the --extra flags used in the guide's command. This change aligns the pyproject.toml file with the documentation by moving the dev and docs dependency groups to [project.optional-dependencies] and adds the missing pre-commit package to the dev group.

This ensures a smooth setup experience for new contributors.

Closes #1970

Type of change

  • Bug fix (non-breaking change which fixes an issue)

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:

  1. Set up a clean virtual environment.
  2. Run the installation command from the contributing guide: uv pip install -r pyproject.toml --extra dev --extra docs --extra metrics.
  3. Verified that the command, which previously failed, now completes successfully and installs all dependencies.

Any specific deployment considerations

None.

Docs

  • Docs updated? What were the changes: N/A

@ArnabTechiee ArnabTechiee requested a review from SkalskiP as a code owner October 3, 2025 15:31
@CLAassistant
Copy link

CLAassistant commented Oct 3, 2025

CLA assistant check
All committers have signed the CLA.

"pandas>=2.0.0",
]

[dependency-groups]
Copy link
Collaborator

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...

Copy link
Contributor

Copilot AI left a 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 dev and docs groups from [dependency-groups] to [project.optional-dependencies] to enable --extra flag usage
  • Added pre-commit package to the dev dependency 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",
Copy link

Copilot AI Jan 7, 2026

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.

Suggested change
"pre-commit",
"pre-commit>=3.0.0",

Copilot uses AI. Check for mistakes.
@Borda
Copy link
Collaborator

Borda commented Jan 7, 2026

Closing since there is a change to the actual upstream version...
@ArnabTechiee, anyway, thank you for your time and effort 🐰

@Borda Borda closed this Jan 7, 2026
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.

--extra dev/docs not recognized by uv

3 participants