poetry-plugin-dotenv - is the plugin that automatically loads environment variables from a dotenv file into the environment before poetry commands are run.
Project description
🔮 Overview
poetry-plugin-dotenv
- is the plugin that automatically loads environment variables from a dotenv file into the environment before poetry
commands are run.
This plugin doesn't have any dependencies, but therefore it also supports features that python-dotenv
supports (e.g. templates, interpolating variables using POSIX
variable expansions etc).
⚙️ Installation
poetry self add poetry-plugin-dotenv
👩🏻💻 Usage
By default, plugin will load the .env
file from the current working directory or "higher directories".
To prevent poetry
from loading the dotenv file, set the POETRY_DONT_LOAD_DOTENV
environment variable.
If your dotenv file is located in a different path or has a different name you may set the POETRY_DOTENV_LOCATION
environment variable.
# .env
DB__HOST=localhost
DB__DBNAME=prod
DB__USER=admin
DB__PASSWORD=admin
DB__ENGINE=postgresql://${DB__USER}:${DB__PASSWORD}@${DB__HOST}/${DB__DBNAME}
# .env.dev
DB__HOST=localhost
DB__DBNAME=dev
DB__USER=root
DB__PASSWORD=root
DB__ENGINE=postgresql://${DB__USER}:${DB__PASSWORD}@${DB__HOST}/${DB__DBNAME}
# main.py
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 from '.env'.
# Host: 'localhost'
# Name: 'prod'
# Username: 'admin'
# Password: 'admin'
# Engine 'postgresql://admin:admin@localhost/prod'
export POETRY_DOTENV_LOCATION=.env.dev && poetry run -vvv python main.py
# Loading environment variables from '.env.dev'.
# Host: 'localhost'
# Name: 'dev'
# Username: 'root'
# Password: 'root'
# Engine 'postgresql://root:root@localhost/dev'
export POETRY_DONT_LOAD_DOTENV=1 && poetry run -vvv python main.py
# Not loading environment variables.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for poetry_plugin_dotenv-0.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e2f882243b9e94270518a066760e535cc6f3b444c2c90b03b6fb398cea757fe3 |
|
MD5 | 19c2ef0e786fae3dfad23256dfc92920 |
|
BLAKE2b-256 | 2748b7b6bce16c701124db2ea993bf619e8a480280ace238c0f28d5aafc5b434 |
Hashes for poetry_plugin_dotenv-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 07aff89ce7da6c2c698d6198bf3404e3e8020df675de6af3a236252839cd92e4 |
|
MD5 | 9b77b37888bb2507bdecd3b7dae10372 |
|
BLAKE2b-256 | a1aa5b2229bda1f1842556bc9cb56cd78773dae16a7b021612bc5a741ca10d84 |