Skip to content

env

tergite_autocalibration.config.env

Classes:

Name Description
EnvironmentConfiguration

A class to .env file or create environment configurations from within the framework

EnvironmentConfiguration

EnvironmentConfiguration()

Bases: BaseConfigurationFile

A class to .env file or create environment configurations from within the framework

Methods:

Name Description
from_dot_env

Load the values from the .env file actually into the os environment.

from_dot_env staticmethod

from_dot_env(filepath: Union[str, Path] = _get_default_env_path(), write_env: bool = False) -> EnvironmentConfiguration

Load the values from the .env file actually into the os environment.

Parameters:

Name Type Description Default
filepath Union[str, Path]

Path to the .env file. Then the environment will be loaded from that location instead.

_get_default_env_path()
write_env bool

If write_env is set to true, then values that are written to this configuration will be written to the .env file. Can be also set in the .env file itself.

False

Returns:

Type Description
EnvironmentConfiguration

An instance of EnvironmentConfiguration which has all values from the environment set.