From b7dba24c01672d767559a8a5f818f1db201b83af Mon Sep 17 00:00:00 2001 From: Alejandro Angulo Date: Tue, 4 Oct 2022 23:23:27 -0700 Subject: [PATCH] docs: add environment variables inline --- docs/configuration.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/docs/configuration.md b/docs/configuration.md index d4586e3da0c..d8c354bed87 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -149,6 +149,8 @@ You can override the Cache directory by setting the `POETRY_CACHE_DIR` environme **Type**: `string` +**Environment Variable**: `POETRY_CACHE_DIR` + The path to the cache directory used by Poetry. Defaults to one of the following directories: @@ -163,6 +165,8 @@ Defaults to one of the following directories: **Default**: `false` +**Environment Variable**: `POETRY_EXPERIMENTAL_SYSTEM_GIT_CLIENT` + *Introduced in 1.2.0* Use system git client backend for git related tasks. @@ -177,6 +181,8 @@ If you encounter any problems with it, set to `true` to use the system git backe **Default**: `number_of_cores + 4` +**Environment Variable**: `POETRY_INSTALLER_MAX_WORKERS` + *Introduced in 1.2.0* Set the maximum number of workers while using the parallel installer. @@ -196,6 +202,8 @@ This configuration is ignored when `installer.parallel` is set to `false`. **Default**: `false` +**Environment Variable**: `POETRY_INSTALLER_NO_BINARY` + *Introduced in 1.2.0* When set this configuration allows users to configure package distribution format policy for all or @@ -245,6 +253,8 @@ across all your projects if incorrectly set. **Default**: `true` +**Environment Variable**: `POETRY_INSTALLER_PARALLEL` + *Introduced in 1.1.4* Use parallel execution when using the new (`>=1.1.0`) installer. @@ -255,6 +265,8 @@ Use parallel execution when using the new (`>=1.1.0`) installer. **Default**: `true` +**Environment Variable**: `POETRY_VIRTUALENVS_CREATE` + Create a new virtual environment if one doesn't already exist. If set to `false`, Poetry will not create a new virtual environment. If it detects a virtual environment @@ -281,6 +293,8 @@ might contain additional Python packages as well. **Default**: `None` +**Environment Variable**: `POETRY_VIRTUALENVS_IN_PROJECT` + Create the virtualenv inside the project's root directory. If not set explicitly, `poetry` by default will create virtual environment under @@ -297,6 +311,8 @@ If set to `false`, `poetry` will ignore any existing `.venv` directory. **Default**: `false` +**Environment Variable**: `POETRY_VIRTUALENVS_OPTIONS_ALWAYS_COPY` + *Introduced in 1.2.0* If set to `true` the `--always-copy` parameter is passed to `virtualenv` on creation of the virtual environment, so that @@ -308,6 +324,8 @@ all needed files are copied into it instead of symlinked. **Default**: `false` +**Environment Variable**: `POETRY_VIRTUALENVS_OPTIONS_NO_PIP` + *Introduced in 1.2.0* If set to `true` the `--no-pip` parameter is passed to `virtualenv` on creation of the virtual environment. This means @@ -328,6 +346,8 @@ packages. This is desirable for production environments. **Default**: `false` +**Environment Variable**: `POETRY_VIRTUALENVS_OPTIONS_NO_SETUPTOOLS` + *Introduced in 1.2.0* If set to `true` the `--no-setuptools` parameter is passed to `virtualenv` on creation of the virtual environment. This @@ -345,6 +365,8 @@ available within a virtual environment. This can cause some features in these to **Default**: `false` +**Environment Variable**: `POETRY_VIRTUALENVS_OPTIONS_SYSTEM_SITE_PACKAGES` + Give the virtual environment access to the system site-packages directory. Applies on virtualenv creation. @@ -354,6 +376,8 @@ Applies on virtualenv creation. **Default**: `{cache-dir}/virtualenvs` +**Environment Variable**: `POETRY_VIRTUALENVS_PATH` + Directory where virtual environments will be created. ### `virtualenvs.prefer-active-python` (experimental) @@ -362,6 +386,8 @@ Directory where virtual environments will be created. **Default**: `false` +**Environment Variable**: `POETRY_VIRTUALENVS_PREFER_ACTIVE_PYTHON` + *Introduced in 1.2.0* Use currently activated Python version to create a new virtual environment. @@ -373,6 +399,8 @@ If set to `false`, Python version used during Poetry installation is used. **Default**: `{project_name}-py{python_version}` +**Environment Variable**: `POETRY_VIRTUALENVS_PROMPT` + *Introduced in 1.2.0* Format string defining the prompt to be displayed when the virtual environment is activated. @@ -382,12 +410,16 @@ The variables `project_name` and `python_version` are available for formatting. **Type**: `string` +**Environment Variable**: `POETRY_REPOSITORIES_` + Set a new alternative repository. See [Repositories]({{< relref "repositories" >}}) for more information. ### `http-basic.`: **Type**: `(string, string)` +**Environment Variable**: `POETRY_HTTP_BASIC_` + Set repository credentials (`username` and `password`) for ``. See [Repositories - Configuring credentials]({{< relref "repositories#configuring-credentials" >}}) for more information. @@ -396,6 +428,8 @@ for more information. **Type**: `string` +**Environment Variable**: `POETRY_PYPI_TOKEN_` + Set repository credentials (using an API token) for ``. See [Repositories - Configuring credentials]({{< relref "repositories#configuring-credentials" >}}) for more information. @@ -404,6 +438,8 @@ for more information. **Type**: `string | boolean` +**Environment Variable**: `POETRY_CERTIFICATES__CERT` + Set custom certificate authority for repository ``. See [Repositories - Configuring credentials - Custom certificate authority]({{< relref "repositories#custom-certificate-authority-and-mutual-tls-authentication" >}}) for more information. @@ -415,6 +451,8 @@ repository. **Type**: `string` +**Environment Variable**: `POETRY_CERTIFICATES__CLIENT_CERT` + Set client certificate for repository ``. See [Repositories - Configuring credentials - Custom certificate authority]({{< relref "repositories#custom-certificate-authority-and-mutual-tls-authentication" >}}) for more information.