simple-dataclass-settings 0.0.2

No project description provided

simple_dataclass_settings

Simple library on top of dataclasses to create shiny-looking configs from environment variables.

Example usage

import dataclass_env


@dataclass_env.settings
class SomeChildSettings:
    some_float: float = dataclass_env.field.float(
        var='SOME_FLOAT',
    )


@dataclass_env.settings
class Settings:
    some_child: SomeChildSettings
    some_string: str = dataclass_env.field.str(
        var='SOME_STRING',
        default='test',
    )
    some_number: int = dataclass_env.field.int(
        var='SOME_NUMBER',
        default=69,
    )
    some_flag: bool = dataclass_env.field.bool(
        var='SOME_FLAG',
        default=False,
    )
    some_list: bool = dataclass_env.field.str_list(
        var='SOME_LIST',
        default=['test', 'vars'],
    )


settings = dataclass_env.populate(Settings)

Interface

• settings - decorator that converts a class to the settings class (just a regular frozen (and slotted) dataclass)
• field - class that creates a special setting field object (that holds metadata about environment variables and its processing)
• populate - function that creates an instance of passed settings class
• show - function that shows a list of environment variables used by the passed class
• read_envfile - function that populates variables from the env file