Skip to content

Commit

Permalink
doc: update path dependency editable defaults
Browse files Browse the repository at this point in the history
  • Loading branch information
finswimmer authored Sep 27, 2020
1 parent 346da80 commit d4eb422
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,16 +230,18 @@ poetry add ../my-package/dist/my-package-0.1.0.tar.gz
poetry add ../my-package/dist/my_package-0.1.0.whl
```

Path dependencies pointing to a local directory will be installed in editable mode (i.e. setuptools "develop mode").
It means that changes in the local directory will be reflected directly in environment.

If you don't want the dependency to be installed in editable mode you can specify it in the `pyproject.toml` file:
If you want the dependency to be installed in editable mode you can specify it in the `pyproject.toml` file. It means that changes in the local directory will be reflected directly in environment.

```toml
[tool.poetry.dependencies]
my-package = {path = "../my/path", develop = false}
my-package = {path = "../my/path", develop = true}
```

!!!note

Before poetry 1.1 path dependencies were installed in editable mode by default. You should always set the `develop` attribute explicit,
to make sure the behavior is the same for all poetry versions.

If the package(s) you want to install provide extras, you can specify them
when adding the package:

Expand Down

0 comments on commit d4eb422

Please sign in to comment.