fix(docs): add pip install -e ".[dev,test]" support and update macOS setup guide#1205
Open
jhhornn wants to merge 5 commits intomalariagen:masterfrom
Open
fix(docs): add pip install -e ".[dev,test]" support and update macOS setup guide#1205jhhornn wants to merge 5 commits intomalariagen:masterfrom
jhhornn wants to merge 5 commits intomalariagen:masterfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #1204
What problem does this solve?
Currently, the project's optional dependency groups (
dev,test, docs) are only defined under[tool.poetry.group.*.dependencies], which means they are only installable via Poetry. Contributors or users who prefer plainpipcannot install these groups withpip install -e ".[dev,test]"because the standard[project.optional-dependencies]table is missing from pyproject.toml.Additionally, the macOS setup guide (MACOS_SETUP.md) references the outdated command
pip install -e ".[dev]", which omits thetestdependency group.How does it solve it?
pyproject.toml
[project]table withnameanddynamic = ["version"].[project.optional-dependencies]withdev,test, and docs groups mirroring the existing Poetry dependency groups. This enablespip install -e ".[dev,test,docs]"for contributors who don't use Poetry.MACOS_SETUP.md
pip install -e ".[dev]"withpip install -e ".[dev,test]"and adds a dedicated "Install the package and its dependencies" section.Testing done
pip install -e ".[dev,test]"resolves and installs all expected packages.poetry install --with dev,test,docscontinues to work as before.pre-commit run --all-files).Breaking changes
None. This is a purely additive change — existing Poetry-based workflows are unaffected.