Commit 152f01e4 by Alejandro Angulo Committed by GitHub

Added environment variables for configurations (#6711)

parent aa333158
...@@ -149,6 +149,8 @@ You can override the Cache directory by setting the `POETRY_CACHE_DIR` environme ...@@ -149,6 +149,8 @@ You can override the Cache directory by setting the `POETRY_CACHE_DIR` environme
**Type**: `string` **Type**: `string`
**Environment Variable**: `POETRY_CACHE_DIR`
The path to the cache directory used by Poetry. The path to the cache directory used by Poetry.
Defaults to one of the following directories: Defaults to one of the following directories:
...@@ -163,6 +165,8 @@ Defaults to one of the following directories: ...@@ -163,6 +165,8 @@ Defaults to one of the following directories:
**Default**: `false` **Default**: `false`
**Environment Variable**: `POETRY_EXPERIMENTAL_SYSTEM_GIT_CLIENT`
*Introduced in 1.2.0* *Introduced in 1.2.0*
Use system git client backend for git related tasks. 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 ...@@ -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` **Default**: `number_of_cores + 4`
**Environment Variable**: `POETRY_INSTALLER_MAX_WORKERS`
*Introduced in 1.2.0* *Introduced in 1.2.0*
Set the maximum number of workers while using the parallel installer. Set the maximum number of workers while using the parallel installer.
...@@ -209,6 +215,8 @@ you encounter on the [issue tracker](https://github.com/python-poetry/poetry/iss ...@@ -209,6 +215,8 @@ you encounter on the [issue tracker](https://github.com/python-poetry/poetry/iss
**Default**: `false` **Default**: `false`
**Environment Variable**: `POETRY_INSTALLER_NO_BINARY`
*Introduced in 1.2.0* *Introduced in 1.2.0*
When set this configuration allows users to configure package distribution format policy for all or When set this configuration allows users to configure package distribution format policy for all or
...@@ -258,6 +266,8 @@ across all your projects if incorrectly set. ...@@ -258,6 +266,8 @@ across all your projects if incorrectly set.
**Default**: `true` **Default**: `true`
**Environment Variable**: `POETRY_INSTALLER_PARALLEL`
*Introduced in 1.1.4* *Introduced in 1.1.4*
Use parallel execution when using the new (`>=1.1.0`) installer. Use parallel execution when using the new (`>=1.1.0`) installer.
...@@ -268,6 +278,8 @@ Use parallel execution when using the new (`>=1.1.0`) installer. ...@@ -268,6 +278,8 @@ Use parallel execution when using the new (`>=1.1.0`) installer.
**Default**: `true` **Default**: `true`
**Environment Variable**: `POETRY_VIRTUALENVS_CREATE`
Create a new virtual environment if one doesn't already exist. 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 If set to `false`, Poetry will not create a new virtual environment. If it detects a virtual environment
...@@ -294,6 +306,8 @@ might contain additional Python packages as well. ...@@ -294,6 +306,8 @@ might contain additional Python packages as well.
**Default**: `None` **Default**: `None`
**Environment Variable**: `POETRY_VIRTUALENVS_IN_PROJECT`
Create the virtualenv inside the project's root directory. Create the virtualenv inside the project's root directory.
If not set explicitly, `poetry` by default will create virtual environment under If not set explicitly, `poetry` by default will create virtual environment under
...@@ -310,6 +324,8 @@ If set to `false`, `poetry` will ignore any existing `.venv` directory. ...@@ -310,6 +324,8 @@ If set to `false`, `poetry` will ignore any existing `.venv` directory.
**Default**: `false` **Default**: `false`
**Environment Variable**: `POETRY_VIRTUALENVS_OPTIONS_ALWAYS_COPY`
*Introduced in 1.2.0* *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 If set to `true` the `--always-copy` parameter is passed to `virtualenv` on creation of the virtual environment, so that
...@@ -321,6 +337,8 @@ all needed files are copied into it instead of symlinked. ...@@ -321,6 +337,8 @@ all needed files are copied into it instead of symlinked.
**Default**: `false` **Default**: `false`
**Environment Variable**: `POETRY_VIRTUALENVS_OPTIONS_NO_PIP`
*Introduced in 1.2.0* *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 If set to `true` the `--no-pip` parameter is passed to `virtualenv` on creation of the virtual environment. This means
...@@ -341,6 +359,8 @@ packages. This is desirable for production environments. ...@@ -341,6 +359,8 @@ packages. This is desirable for production environments.
**Default**: `false` **Default**: `false`
**Environment Variable**: `POETRY_VIRTUALENVS_OPTIONS_NO_SETUPTOOLS`
*Introduced in 1.2.0* *Introduced in 1.2.0*
If set to `true` the `--no-setuptools` parameter is passed to `virtualenv` on creation of the virtual environment. This If set to `true` the `--no-setuptools` parameter is passed to `virtualenv` on creation of the virtual environment. This
...@@ -358,6 +378,8 @@ available within a virtual environment. This can cause some features in these to ...@@ -358,6 +378,8 @@ available within a virtual environment. This can cause some features in these to
**Default**: `false` **Default**: `false`
**Environment Variable**: `POETRY_VIRTUALENVS_OPTIONS_SYSTEM_SITE_PACKAGES`
Give the virtual environment access to the system site-packages directory. Give the virtual environment access to the system site-packages directory.
Applies on virtualenv creation. Applies on virtualenv creation.
...@@ -367,6 +389,8 @@ Applies on virtualenv creation. ...@@ -367,6 +389,8 @@ Applies on virtualenv creation.
**Default**: `{cache-dir}/virtualenvs` **Default**: `{cache-dir}/virtualenvs`
**Environment Variable**: `POETRY_VIRTUALENVS_PATH`
Directory where virtual environments will be created. Directory where virtual environments will be created.
{{% note %}} {{% note %}}
...@@ -379,6 +403,8 @@ This setting controls the global virtual environment storage path. It most likel ...@@ -379,6 +403,8 @@ This setting controls the global virtual environment storage path. It most likel
**Default**: `false` **Default**: `false`
**Environment Variable**: `POETRY_VIRTUALENVS_PREFER_ACTIVE_PYTHON`
*Introduced in 1.2.0* *Introduced in 1.2.0*
Use currently activated Python version to create a new virtual environment. Use currently activated Python version to create a new virtual environment.
...@@ -390,6 +416,8 @@ If set to `false`, Python version used during Poetry installation is used. ...@@ -390,6 +416,8 @@ If set to `false`, Python version used during Poetry installation is used.
**Default**: `{project_name}-py{python_version}` **Default**: `{project_name}-py{python_version}`
**Environment Variable**: `POETRY_VIRTUALENVS_PROMPT`
*Introduced in 1.2.0* *Introduced in 1.2.0*
Format string defining the prompt to be displayed when the virtual environment is activated. Format string defining the prompt to be displayed when the virtual environment is activated.
...@@ -399,12 +427,16 @@ The variables `project_name` and `python_version` are available for formatting. ...@@ -399,12 +427,16 @@ The variables `project_name` and `python_version` are available for formatting.
**Type**: `string` **Type**: `string`
**Environment Variable**: `POETRY_REPOSITORIES_<NAME>`
Set a new alternative repository. See [Repositories]({{< relref "repositories" >}}) for more information. Set a new alternative repository. See [Repositories]({{< relref "repositories" >}}) for more information.
### `http-basic.<name>`: ### `http-basic.<name>`:
**Type**: `(string, string)` **Type**: `(string, string)`
**Environment Variable**: `POETRY_HTTP_BASIC_<NAME>`
Set repository credentials (`username` and `password`) for `<name>`. Set repository credentials (`username` and `password`) for `<name>`.
See [Repositories - Configuring credentials]({{< relref "repositories#configuring-credentials" >}}) See [Repositories - Configuring credentials]({{< relref "repositories#configuring-credentials" >}})
for more information. for more information.
...@@ -413,6 +445,8 @@ for more information. ...@@ -413,6 +445,8 @@ for more information.
**Type**: `string` **Type**: `string`
**Environment Variable**: `POETRY_PYPI_TOKEN_<NAME>`
Set repository credentials (using an API token) for `<name>`. Set repository credentials (using an API token) for `<name>`.
See [Repositories - Configuring credentials]({{< relref "repositories#configuring-credentials" >}}) See [Repositories - Configuring credentials]({{< relref "repositories#configuring-credentials" >}})
for more information. for more information.
...@@ -421,6 +455,8 @@ for more information. ...@@ -421,6 +455,8 @@ for more information.
**Type**: `string | boolean` **Type**: `string | boolean`
**Environment Variable**: `POETRY_CERTIFICATES_<NAME>_CERT`
Set custom certificate authority for repository `<name>`. Set custom certificate authority for repository `<name>`.
See [Repositories - Configuring credentials - Custom certificate authority]({{< relref "repositories#custom-certificate-authority-and-mutual-tls-authentication" >}}) See [Repositories - Configuring credentials - Custom certificate authority]({{< relref "repositories#custom-certificate-authority-and-mutual-tls-authentication" >}})
for more information. for more information.
...@@ -432,6 +468,8 @@ repository. ...@@ -432,6 +468,8 @@ repository.
**Type**: `string` **Type**: `string`
**Environment Variable**: `POETRY_CERTIFICATES_<NAME>_CLIENT_CERT`
Set client certificate for repository `<name>`. Set client certificate for repository `<name>`.
See [Repositories - Configuring credentials - Custom certificate authority]({{< relref "repositories#custom-certificate-authority-and-mutual-tls-authentication" >}}) See [Repositories - Configuring credentials - Custom certificate authority]({{< relref "repositories#custom-certificate-authority-and-mutual-tls-authentication" >}})
for more information. for more information.
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