py-configr 0.1.0

A flexible, type-safe configuration management library for Python

Configr

A flexible, type-safe configuration management library for Python.

Configr simplifies configuration management by leveraging Python's dataclasses and type hints to provide a robust, type-safe approach to application configuration.

• Type Safety: Leverage Python's type hints for configuration validation
• Dataclass Integration: Seamlessly map configuration files to Python dataclasses
• Multiple Format Support: Load configuration from JSON and YAML files
• Extendable: Easily add support for custom configuration formats
• Simple API: Convenient decorator-based approach for defining configuration classes

Requirements

• Python 3.10 or higher

Installation

pip install py-configr

# For YAML support
pip install py-configr[yaml]

Quick Start

Define your configuration class:

from configr import config_class, ConfigBase

@config_class(file_name="database.json")
class DatabaseConfig:
    host: str
    port: int = 5432
    username: str
    password: str
    database: str

# Load configuration
db_config = ConfigBase.load(DatabaseConfig)

# Use configuration
print(f"Connecting to {db_config.database} at {db_config.host}:{db_config.port}")

Create a configuration file in _config/database.json:

{
  "host": "localhost",
  "username": "admin",
  "password": "secure_password",
  "database": "my_app"
}

Documentation

For complete documentation, visit our documentation site.

• Getting Started
• API Reference
• Examples

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.