docs: update README.md to enhance environment loader description and use cases

This commit is contained in:
Dominik Krenn 2025-07-01 09:48:35 +02:00
parent fa1f4df594
commit 4f0860180c

View File

@ -1,3 +1,24 @@
# multinut
# multinut
The multitool nobody asked for. Includes stuff like `greet()`, `add()`, and other functions you'll forget are here.
The multitool nobody asked for. Includes stuff and so
---
## `multinut.env`
A simple but flexible environment loader.
Supports `.env` file parsing with optional mode suffixes (e.g. `.env.production`, `.env.testing`, etc.), lazy loading, and dynamic access.
Useful when:
* You want a single class that can load environment configs based on mode (`development`, `production`, etc.)
* You need access via `env["KEY"]`, `env.get("KEY")`, or even `env.KEY`
* You want optional type casting and sane default handling
* You *dont* want `os.environ` to be touched
### Use cases
* Loading `.env` files in mode-aware Python projects
* Separating secrets and configs by deployment context
* Dynamically reading values like `env.DB_URL`, `env.get("DEBUG", default=False, cast=bool)`
* Avoiding external dependencies beyond `python-dotenv`