python-poetry / python-poetry/poetry

What does it actually mean to install a git dependency in editable mode?

Open
#6,390 9 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/docs kind/question
Dominant language
Python
Stars
34.3k
Forks
2.5k
Avg merge
2d 19h
Merged PRs (30d)
30

Description

Hi, I see in the documentation it's possible to install a git dependency in editable mode:

poetry add --editable git+https://github.com/some-repository

But I'm having trouble understanding what this actually means. How do I actually .. you know, edit it? Where does it go? I don't see any repo created in my project directory when I do this, although I am able to import it. What is the expected workflow, what am I meant to do with it?

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.

Research direction

Start with the documentation passage covering poetry add --editable git+https://github.com/some-repository and trace the install behavior it describes. Clarify the expected workflow, where the dependency is placed, and how a user edits it; the documentation is done when these questions are answered without requiring project-specific guesswork.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.