runch 1.0.0

Runch: refined munch. With generic typing support.

Runch

Refined munch. Provides basic munch functionality with additional typing support and runtime validation.

Installation

pip install runch

Usage

from runch import RunchModel, RunchConfigReader

class ExampleConfig(RunchModel):
    db_host: str
    db_port: int
    db_user: str
    db_password: str
    db_name: str


example_config = RunchConfigReader[ExampleConfig].read("example_config_file", "example_config_dir", "yaml")

print(example_config.config.db_host)  # with intellicode support & runtime validation

$ touch example_config_dir/example_config_file.yaml

db_host: localhost
db_port: 5432
db_user: user
db_password: password
db_name: database

Model Generator

$ python -m runch <config_name> [config_ext]

Manual:

Generate a model definition from a config file.

config_name: the name of the config file without the extension.
config_ext: the extension of the config file. Default is `yaml`.

Use RUNCH_CONFIG_DIR environment variable to specify the directory of the config files. Default is `./etc`.

Example:
    python -m runch my_config
    python -m runch my_config yaml