Skip to content

Update README install command for the test dependency group - #1573

Merged
davidbrochart merged 1 commit into
ipython:mainfrom
cristianchiriac:docs/readme-test-dependency-group
Oct 5, 2026
Merged

davidbrochart merged 1 commit into
ipython:mainfrom
cristianchiriac:docs/readme-test-dependency-group

Conversation

@cristianchiriac

Copy link
Copy Markdown
Contributor

Since #1563 moved the test requirements from the test extra to a test dependency group, the README's "Installation from source" step

pip install -e ".[test]"

only prints WARNING: ipykernel 7.4.0 does not provide the extra 'test' and installs none of the test requirements. Following "Running tests" then fails at collection, because pytest-timeout and others are missing (Unknown config option: timeout).

This changes the step to pip install -e . --group test, with a note that it needs pip ≥ 25.1.

I checked both commands in a fresh venv (pip 26.2.1, Python 3.13). The old one warns and installs nothing for tests. The new one installs pytest, pytest-timeout, etc., and pytest --co collects the suite.

IPython's downstream workflow had the same problem: ipython/ipython#15418.

The test requirements moved from the "test" extra to a "test" dependency
group in ipython#1563. 'pip install -e ".[test]"' now only warns that the extra
does not exist and installs none of the test requirements, so the
'Running tests' instructions fail (e.g. pytest-timeout is missing).

@davidbrochart davidbrochart left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@davidbrochart
davidbrochart merged commit a2b7a3e into ipython:main Oct 5, 2026
38 of 39 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants