python-poetry / python-poetry/poetry
Rename "develop" option to "editable"
Open
@Secrus is already working on this.
Since Sep 25, 2024.
kind/enhancement
kind/feature
- Dominant language
- Python
- Stars
- 34.3k
- Forks
- 2.5k
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 30
Description
We should rename the dependency option develop to editable to align with what it actually is and to avoid confusion with a
"development dependency".
- foo = { path = "./path/to/foo", develop = true }
+ foo = { path = "./path/to/foo", editable = true }
Additionally we should also introduce this as a commandline option to poetry add (eg: poetry add --editable x).
Changes Required
- Update specification schema in
poetry-core. - Update dependency instances to reference
editableand fallback todevelopif not present. - Update references to
Dependency.developin bothpoetry-coreandpoetry. - Add deprecation warning when accessing
Dependency.develop. - Add
poetry checkwarning to inform users about the change. - Add
--editableoption directory and vcs dependencies topoetry addcommand. (This can be an issue on its own.)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.