pyenvcheck 0.1.1

Validate environment configuration at Python app startup with security-first design

pyenvcheck

Validate environment configuration at Python app startup with security-first design.

Python applications often fail late because configuration is not validated at startup. pyenvcheck provides a clean, secure way to:

• ✅ Load and validate environment configuration from .env, TOML, and YAML files
• ✅ Define required/optional keys with type coercion and defaults
• ✅ Apply custom validators and transformations
• ✅ Mask sensitive values in startup summaries
• ✅ Get structured config as dataclass or Pydantic models
• ✅ Use the CLI to check config validity before deployment
• ✅ Integrate seamlessly with Django, FastAPI, and Flask

Quick Start

Installation

pip install pyenvcheck

Basic Usage

from pyenvcheck import Config

config = Config({
    'DATABASE_URL': {'required': True},
    'DEBUG': {'type': bool, 'default': False},
    'PORT': {'type': int, 'default': 8000},
    'SECRET_KEY': {'required': True, 'mask': True},
})

# Load from environment
validated_config = config.validate()

# Or load from .env file
validated_config = config.load_env('.env').validate()

# Access config
print(validated_config.DATABASE_URL)

# Get startup summary (secrets masked)
print(validated_config.summary())

Output as Pydantic Model

from pydantic import BaseModel
from pyenvcheck import Config

class Settings(BaseModel):
    database_url: str
    debug: bool = False
    port: int = 8000

config = Config.from_pydantic(Settings)
settings = config.load_env('.env').validate_as(Settings)

CLI Check

# Validate configuration before deploying
pyenvcheck check --config config.yaml --env production

# Generate example config
pyenvcheck generate --output .env.example

Django Integration

# settings.py
from pyenvcheck.adapters.django import get_settings

ALLOWED_HOSTS = get_settings(settings_dict).ALLOWED_HOSTS

FastAPI Integration

from pyenvcheck.adapters.fastapi import get_settings

settings = get_settings()
app = FastAPI()

Features

• Multiple Source Support: Load config from environment variables, .env files, YAML, and TOML
• Source Merging: Combine multiple config sources with defined priority
• Type Coercion: Automatic conversion to int, bool, float, list, etc.
• Validation: Required fields, optional with defaults, custom validators
• Security: Mask sensitive values in logs and summaries
• Structured Output: Pydantic or dataclass-style access
• CLI Tools: Validate config and generate examples
• Framework Integration: Django, FastAPI, Flask adapters
• Comprehensive Errors: Clear error messages with suggestions

Documentation

• Getting Started Guide
• API Reference
• Framework Adapters
• Examples

Development

# Clone and install in development mode
git clone https://github.com/yourusername/pyenvcheck.git
cd pyenvcheck
pip install -e ".[dev]"

# Run tests
pytest

# Format code
black src tests
isort src tests

# Type checking
mypy src

# Build docs
mkdocs serve

License

MIT License - see LICENSE file for details.

Contributing

Contributions are welcome! Please see our contribution guidelines.