poetry-plugin-dotenv 3.3.0

• Overview
  • Features
• Installation
• Usage and Configuration
  • ignore
  • location
  • Configuration via TOML file
  • Configuration via environment variables
  • Lookup hierarchy
• Examples

Overview

poetry-plugin-dotenv - is the plugin that automatically loads environment variables from a dotenv file into the environment before poetry commands are run.

poetry-plugin-dotenv introduces new commands to extend the functionality of poetry such as:

• poetry activate - loads environment variables from a dotenv file and activates the virtual environment

Features

• Fully type-safe
• No external dependencies required
• Brings back beloved activate command with extended functionality
• Supports templates and variable interpolation using POSIX variable expansions
• Supports --directory, which allows setting the working directory for the poetry command
• Supports multiple configuration sources
• Provides configuration auto-completion and validation in IDEs like Visual Studio Code or PyCharm (via JSON Schema Store)
• Supports both poetry v1.5+ and poetry v2+

Installation

poetry self add poetry-plugin-dotenv@latest

[!TIP] New releases support only Python 3.9+. If you want to use poetry-plugin-dotenv with Python 3.8, please install version 2.4.0 using poetry self add poetry-plugin-dotenv@2.4.0

Usage and Configuration

By default, the plugin will load the .env file from the current working directory or any higher-level directories.

ignore

Type: str

Default: false

Allowed values (as True): y / yes / t / on / 1 / true

Allowed values (as False): n / no / f / off / 0 / false

Prevents poetry from loading the dotenv file.

location

Type: str

Default: .env

If your dotenv file is located elsewhere or has a different name, you can set this parameter.

Configuration via TOML file

The plugin can read project-specific default values for its options from a pyproject.toml file. By default, poetry-plugin-dotenv looks for a pyproject.toml file that includes either a [tool.dotenv] or [tool.poetry.plugins.dotenv] section.

Example pyproject.toml:

[tool.dotenv]
ignore = "false"
location = ".env.dev"

[tool.poetry.plugins.dotenv]
ignore = "false"
location = ".env.dev"

[!WARNING] In upcoming poetry releases, the [tool.poetry.plugins] section will be deprecated. Please migrate to [tool.dotenv].

[!IMPORTANT] Due to poetry's default parser, all options in the plugin sections must be specified as strings.

As mentioned in the Features list, the schema for the plugin configuration is part of the JSON Schema Store, which enables auto-completion and validation in IDEs like Visual Studio Code and PyCharm.

Configuration via environment variables

poetry-plugin-dotenv supports the following configuration options via environment variables:

• POETRY_PLUGIN_DOTENV_LOCATION
• POETRY_PLUGIN_DOTENV_IGNORE

[!IMPORTANT] As environment variables are always strings, options should always be set as strings.

Lookup hierarchy

A pyproject.toml file can override default values. Options provided via environment variables override both.

Examples

Example of using activate command:

# .env
DB__HOST=localhost
DB__DBNAME=local_lakehouse
DB__USER=volodymyr
DB__PASSWORD=super_secret_password
DB__ENGINE=postgresql://${DB__USER}:${DB__PASSWORD}@${DB__HOST}/${DB__DBNAME}

poetry activate -v
# Using virtualenv: ...
# Loading environment variables: .../.env

# Reloads shell within the environment with loaded environment variables

Example of using run command:

# .env
DB__HOST=localhost
DB__DBNAME=local_lakehouse
DB__USER=volodymyr
DB__PASSWORD=super_secret_password
DB__ENGINE=postgresql://${DB__USER}:${DB__PASSWORD}@${DB__HOST}/${DB__DBNAME}

# .env.dev
DB__HOST=dev.host
DB__DBNAME=dev_lakehouse
DB__USER=svc_team
DB__PASSWORD=super_secret_password
DB__ENGINE=postgresql://${DB__USER}:${DB__PASSWORD}@${DB__HOST}/${DB__DBNAME}

# pyproject.toml
[tool.dotenv]
location = ".env.dev"

# main.py
from __future__ import annotations

import os


if __name__ == "__main__":
    try:
        print(f"Host: {os.environ['DB__HOST']!r}")
        print(f"Name: {os.environ['DB__DBNAME']!r}")
        print(f"Username: {os.environ['DB__USER']!r}")
        print(f"Password: {os.environ['DB__PASSWORD']!r}")
        print(f"Engine: {os.environ['DB__ENGINE']!r}")

    except KeyError:
        print("Environment variables not set!")

poetry run -vvv python main.py
# Loading environment variables: .env
# Host: 'localhost'
# Name: 'local_lakehouse'
# Username: 'volodymyr'
# Password: 'super_secret_password'
# Engine: 'postgresql://volodymyr:super_secret_password@localhost/local_lakehouse'

# Set location section in pyproject.toml
poetry run -vvv python main.py
# Loading environment variables: .env.dev
# Host: 'dev.host'
# Name: 'dev_lakehouse'
# Username: 'svc_team'
# Password: 'super_secret_password'
# Engine: 'postgresql://svc_team:super_secret_password@dev.host/dev_lakehouse'

# Set ignore = "true" in pyproject.toml
poetry run -vvv python main.py
# Not loading environment variables. Ignored by configuration
# Environment variables not set!

export POETRY_PLUGIN_DOTENV_LOCATION=.env.dev && poetry run -vvv python main.py
# Loading environment variables: .env.dev
# Host: 'dev.host'
# Name: 'dev_lakehouse'
# Username: 'svc_team'
# Password: 'super_secret_password'
# Engine: 'postgresql://svc_team:super_secret_password@dev.host/dev_lakehouse'

export POETRY_PLUGIN_DOTENV_IGNORE=true && poetry run -vvv python main.py
# Not loading environment variables. Ignored by configuration
# Environment variables not set!