Commit d4eb422e by finswimmer Committed by GitHub

doc: update path dependency editable defaults

parent 346da80f
...@@ -230,16 +230,18 @@ poetry add ../my-package/dist/my-package-0.1.0.tar.gz ...@@ -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 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"). 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.
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:
```toml ```toml
[tool.poetry.dependencies] [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 If the package(s) you want to install provide extras, you can specify them
when adding the package: when adding the package:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment