Skip to content

dutradda/confdaora

Repository files navigation

confdaora

confdaora

Configurations using python annotations


Documentation: https://dutradda.github.io/confdaora

Source Code: https://github.com/dutradda/confdaora


Key Features

  • Generate a DictDaora with values parsed from environment variables.

Requirements

  • Python 3.8+
  • dictdaora
  • jsondaora

Instalation

$ pip install confdaora

Basic example

from typing import TypedDict

from confdaora import confdaora_env


class AppConfig(TypedDict):
    port: int
    host: str


config = confdaora_env(AppConfig)

print(config)

Suposing your file calls myconf.py:

PORT=8080 HOST=localhost python myconf.py

{'port': 8080, 'host': 'localhost'}

Complex example

from dataclasses import dataclass
from typing import List

from confdaora import confdaora_env


@dataclass
class DBConfig:
    __prefix__ = 'db'
    host: str
    port: int = 3306


@dataclass
class KeyConfig:
    __prefix__ = 'keys'
    name: str
    values: List[int]


@dataclass
class AppConfig:
    db: DBConfig
    keys: List[KeyConfig]
    host: str
    port: int = 8080


config = confdaora_env(AppConfig)

print(config)

Suposing your file calls myconf.py:

HOST=localhost \
DB_HOST=localhost \
KEYS_0_NAME=test \
KEYS_0_VALUES=10,20 \
KEYS_1_NAME=test2 \
KEYS_1_VALUES=30,40 \
python myconf.py

AppConfig(db=DBConfig(host='localhost', port=3306), keys=[KeyConfig0(name='test', values=[10, 20]), KeyConfig1(name='test2', values=[30, 40])], host='localhost', port=8080)

About

Configurations using python annotations

Resources

License

Stars

Watchers

Forks

Packages

No packages published