eradiate.config
#
This module exposes components dedicated to the global configuration of Eradiate.
Core members#
- eradiate.config.ENV = str#
Path to the Eradiate source code directory, if relevant. Takes the value of the
ERADIATE_SOURCE_DIR
environment variable if it is set; otherwise defaults toNone
.
- eradiate.config.SOURCE_DIR = pathlib.Path or None#
Identifier of the environment in which Eradiate is used. Takes the value of the
ERADIATE_ENV
environment variable if it is set; otherwise defaults to"default"
.
- eradiate.config.settings = dynaconf.Dynaconf#
Main settings data structure. It supports array and attribute indexing, both case-insensitive:
settings["some.key"] settings["SOME.KEY"] settings.some.key settings.SOME.KEY
All settings have a default value specified by the default configuration file and can be overridden by the user from an
eradiate.toml
file, placed in the current working directory or higher. Each setting can also be overridden using environment variables with theERADIATE_
prefix.Example
The
some.key
setting will be accessed asERADIATE_SOME__KEY
(note the double underscore to figure the hierarchical separator).