butterfree.configs package

Submodules

Holds functions for managing the running environment.

exception butterfree.configs.environment.UnspecifiedVariableError(variable_name: str)

Bases: RuntimeError

Environment variables not set error.

variable_name

environment variable name.

butterfree.configs.environment.get_variable(variable_name: str, default_value: str = None) → str

Gets an environment variable.

The variable comes from it’s explicitly declared value in the running environment or from the default value declared in the environment.yaml specification or from the default_value.

Parameters
  • variable_name – environment variable name.

  • default_value – default value to use in case no value is set in the environment nor in the environment.yaml specification file.

Returns

The variable’s string value

Module contents

Holds configuration/setup for Butterfree components.