ecological 1.2

Getting Started

Ecological automatically gets and converts environment variables according to the configuration class definition.

For example, imagine your application has a configurable (integer) Port and (boolean) Debug flag and a (string) Log Level, that is INFO by default, you could simply declare your configuration as:

class Configuration(ecological.AutoConfig):
    port: int
    debug: bool
    log_level: str = "INFO"

And then set the environment variables PORT, DEBUG and LOG_LEVEL. Ecological will automatically set the class properties from the environment variables with the same (but upper cased) name.

The values are set at the class definition type and assigned to the class itself (i.e. the class doesn’t need to be instantiated).

Typing Support

Ecological also supports some of the types defined in PEP484, for example:

class Configuration(ecological.AutoConfig):
    list_of_values: List[str]

Will automatically parse the environment variable value as a list.

Prefixed Configuration

You can also decide to prefix your application configuration, for example, to avoid collisions:

class Configuration(ecological.AutoConfig, prefix='myapp'):
    home: str

In this case the home property will be fetched from the MYAPP_HOME environment property.

Caveats and Known Limitations

• Ecological doesn’t support (public) methods in AutoConfig classes

Advanced Usage

class Configuration(ecological.AutoConfig):
    integer: int

    class Nested(ecological.AutoConfig, prefix='nested'):
        boolean: bool