enventory 0.0.2

A lightweight Python utility for loading and retrieving environment variables

Enventory

Enventory is a lightweight Python utility for loading and retrieving environment variables with optional type casting, defaults, and required flags.

---

Features

• Load environment variables from current directory or specified paths.
• Retrieve environment variables with default values, type casting, and required checks.
• Helper functions for casting strings to booleans or lists.
• Raises clear errors when environment files or required variables are missing.
• Compatible with Python 3.8+.

---

Installation

Once published to PyPI, you can install Enventory via pip:

pip install enventory

Or for local development:

git clone https://github.com/yourusername/enventory.git
cd enventory
pip install -e .

---

Usage

Load Environment Variables

from enventory import loadenv

# Load environment variables from cwd or parent paths
loadenv()

# Load environment variables from a specific file in a base directory
from pathlib import Path
loadenv(base=Path("/path/to/project"), name=".env.production")

Retrieve Environment Variables

from enventory import getenv, to_boolean, to_list

# Get a variable with optional default
db_host = getenv("DB_HOST", default="localhost")

# Get a required variable (raises ValueError if missing)
secret_key = getenv("SECRET_KEY", required=True)

# Cast a variable to boolean
debug_mode = getenv("DEBUG", default="False", cast=to_boolean)

# Cast a comma-separated variable to a list
allowed_hosts = getenv("ALLOWED_HOSTS", default="", cast=to_list)

Helper Functions

from enventory import to_boolean, to_list

to_boolean("yes")  # True
to_boolean("0")    # False

to_list("a,b,c")   # ['a', 'b', 'c']
to_list("a;b;c", separator=";")  # ['a', 'b', 'c']

---

Error Handling

• EnvNotFoundError is raised if loadenv cannot find an environment file.
• ValueError is raised by getenv if a required environment variable is missing.

---

Project Structure

enventory/
├── setup.py
├── pyproject.toml
├── README.md
└── enventory/
    ├── __init__.py  # exposes env.py
    └── env.py       # main environment utility

---

Contributing

Contributions, issues, and feature requests are welcome!

1. Fork the repository
2. Create a new branch (git checkout -b feature-name)
3. Make your changes
4. Submit a pull request

---

License

MIT License © Your Name

---

---

Compatibility

• Python 3.8 and above