Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify use of virtualenvs.in-project setting. #8126

Merged
merged 4 commits into from
Jun 27, 2023
Merged

Clarify use of virtualenvs.in-project setting. #8126

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ea55e5c
Clarify use of virtualenvs.in-project setting.
Davi-Gray Jun 23, 2023
3b89569
Merge branch 'python-poetry:master' into master
Davi-Gray Jun 26, 2023
c46cbb2
Add note on how to find current virtualenv path.
Davi-Gray Jun 26, 2023
e223504
Merge branch 'master' of https://github.com/Davi-Gray/poetry
Davi-Gray Jun 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,12 +309,21 @@ might contain additional Python packages as well.

Create the virtualenv inside the project's root directory.

If not set explicitly, `poetry` by default will create virtual environment under
`{cache-dir}/virtualenvs` or use the `{project-dir}/.venv` directory when one is available.
If not set explicitly, `poetry` by default will create a virtual environment under
`{cache-dir}/virtualenvs` or use the `{project-dir}/.venv` directory if one already exists.

If set to `true`, the virtualenv will be created and expected in a folder named
`.venv` within the root directory of the project.

{{% note %}}
If a virtual environment has already been created for the project under `{cache-dir}/virtualenvs`, setting this variable to `true` will not cause `poetry` to create or use a local virtual environment.

In order for this setting to take effect for a project already in that state, you must delete the virtual environment folder located in `{cache-dir}/virtualenvs`.
radoering marked this conversation as resolved.
Show resolved Hide resolved

You can find out where the current project's virtual environment (if there is one) is stored
with the command `poetry env info --path`.
{{% /note %}}

If set to `false`, `poetry` will ignore any existing `.venv` directory.

### `virtualenvs.options.always-copy`
Expand Down