eyconf 0.2.0

Easy Yaml based Configuration for Python

EYConf

Easy Yaml based Configuration for Python

Features

• Generate: Automatically convert a schema to a yaml configuration file, including comments!
• Validate: Validate a given configuration file against your schema and raise human readable errors!
• Extend: Introduce custom logic by extending the EYConf class!
• Reload: Reload your configuration on the fly without restarting your application!

Installation

You can install EYConf from PyPI using pip.

pip install eyconf

Example Usage

from dataclasses import dataclass
from eyconf import EYConf

@dataclass
class Transport:
    """Email transport configuration"""
    host: str = 'imap.example.com'
    port: int = 993
    username: str = 'user'
    password: str = 'password'
    use_ssl: bool = False

@dataclass
class Other:
    """Other configuration options"""
    bar: int | None = None

@dataclass
class ConfigSchema:
    """My configuration schema

    Docstrings are used as comments in the generated yaml file!
    """
    transport: Transport
    other: Other


config = EYConf(ConfigSchema)

This generate the following config.yaml file in your current working directory:

# My configuration schema
# Docstrings are used as comments in the generated yaml file!

transport:
  # Email transport configuration

  host: imap.example.com
  port: 993
  username: user
  password: password
  use_ssl: false

other:
  # Other configuration options

  bar: null

Please refer to the documentation for more information.