python-poetry / python-poetry/poetry

Rename "develop" option to "editable"

Open
#3,004 4 comments 18 reactions 1 assignee View on GitHub

@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 editable and fallback to develop if not present.
  • Update references to Dependency.develop in both poetry-core and poetry.
  • Add deprecation warning when accessing Dependency.develop.
  • Add poetry check warning to inform users about the change.
  • Add --editable option directory and vcs dependencies to poetry add command. (This can be an issue on its own.)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.