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.
Features
- 📦 Doesn't require any dependencies
- 📝 Supports templates, interpolating variables using POSIX variable expansions
- 🔮 Fully type safe
- 🥷🏻 100% tests coverage and "A" grade for maintainability
⚙️ 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.6.30.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 38ae6996439127a95f5cc800ea9a964cde2040056c9b96b7437fcd2ea5c6be55 |
|
MD5 | de89b74e08ec76af3b4da54440d5a467 |
|
BLAKE2b-256 | 0298da2d644d78554d0d356d1d9ee744cc7532828440c616c78913ddf93d9d05 |
Hashes for poetry_plugin_dotenv-0.6.30-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 33c349a68925ed42197d0f5f4acdd701853c05bf9380a5b976ba0629bf496f3c |
|
MD5 | 910208961d70b53f394035e5ce7d7081 |
|
BLAKE2b-256 | a826b35896ec3c6ff4cd95f905a34a6cc9eee65915fe66ce8e4ca1ad6cd10bc8 |