Skip to content

Commit

Permalink
docs: improved description of virtualenvs.create option (#6460)
Browse files Browse the repository at this point in the history
I tried to clarify how the `virtualenvs.create` config option works and
why it is a good idea to have virtual environments in docker containers
as well.

(cherry picked from commit e803c3d)
  • Loading branch information
finswimmer authored and github-actions[bot] committed Sep 10, 2022
1 parent 015a693 commit 6a098f1
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,23 @@ Use parallel execution when using the new (`>=1.1.0`) installer.

Create a new virtual environment if one doesn't already exist.

If set to `false`, poetry will install dependencies into the current python environment.
If set to `false`, Poetry will not create a new virtual environment. If it detects a virtual environment
in `{cache-dir}/virtualenvs` or `{project-dir}/.venv` it will install dependencies into them, otherwise it will install
dependencies into the systems python environment.

{{% note %}}
If Poetry detects it's running within an activated virtual environment, it will never create a new virtual environment,
regardless of the value set for `virtualenvs.create`.
{{% /note %}}

{{% note %}}
Be aware that installing dependencies into the system environment likely upgrade or uninstall existing packages and thus
break other applications. Installing additional Python packages after installing the project might break the Poetry
project in return.

This is why it is recommended to always create a virtual environment. This is also true in Docker containers, as they
might contain additional Python packages as well.
{{% /note %}}

### `virtualenvs.in-project`

Expand Down

0 comments on commit 6a098f1

Please sign in to comment.