Language: 한국어 | English

Hydra-style Configuration + Pydantic Type Safety + Auto Help Generation

---

☕️ Overview

confee makes configuration management simple, type-safe, and intuitive. Combine config files, Pydantic validation, environment variables, and CLI arguments seamlessly.

---

✨ Features

• 🎯 Type-Safe — Pydantic V2 validation & IDE autocomplete
• 📋 Multi-Format — YAML, JSON, TOML auto-detection
• 🔄 Override System — CLI args & environment variables with priority control
• 🔐 Secret Masking — SecretField() for sensitive data
• 🧊 Immutability — Runtime config freezing
• 📐 Extensible — Plugin system, JSON Schema, async loading

---

📦 Installation

pip install confee

---

🚀 Quick Start

# config.yaml
name: my-app
debug: false
workers: 4

from confee import ConfigBase

class AppConfig(ConfigBase):
    name: str
    debug: bool = False
    workers: int = 4

config = AppConfig.load("config.yaml")
print(f"App: {config.name}, Workers: {config.workers}")

# Override with CLI args
python app.py debug=true workers=8

# Override with environment variables
CONFEE_WORKERS=16 python app.py

# Nested config via environment (use __ for nested keys)
CONFEE_DATABASE__HOST=prod.db CONFEE_DATABASE__PORT=5432 python app.py

Auto-Generated Help

Run with --help to see available options:

$ python app.py --help

Usage: app.py [OPTIONS]

Options:
  --name     str   name
  --debug    bool  debug [default: False]
  --workers  int   workers [default: 4]

Override format:
  key=value              Set a simple value
  nested.key=value       Set a nested value
  @file:path/to/file     Read value from file
  true/false/yes/no/on/off for boolean values

Examples:
  app.py debug=true workers=8
  app.py --help

---

💡 Common Patterns

Nested Configuration

class DatabaseConfig(ConfigBase):
    host: str = "localhost"
    port: int = 5432

class AppConfig(ConfigBase):
    database: DatabaseConfig

config = AppConfig.load("config.yaml")

python app.py database.host=prod.db database.port=3306

Config Freezing

config = AppConfig.load("config.yaml")
config.freeze()

try:
    config.name = "changed"
except AttributeError:
    print("Config is frozen!")

---

📚 Documentation

See examples/ for more:

• 01_basic_usage.py - Type-safe config, freezing
• 02_cli_overrides.py - CLI args & env vars
• 03_secrets.py - SecretField & masking
• 04_fastapi.py - FastAPI integration

For advanced features, see ADVANCED.md:

• Config Freezing & Immutability
• JSON Schema Generation
• Remote Config Loading (HTTP/HTTPS)
• Plugin System (Custom Loaders, Validators, Hooks)
• Config Diff & Merge
• Integration Examples (FastAPI, Django, Kubernetes, AWS Lambda)

---

📄 License

MIT License © 2025 — See LICENSE for details.