load_config

Part of Configuration & authentication in the Python API reference.

Related guidance: getting-started/configuration, getting-started/authentication, security/credentials.

Runnable examples: preflight.py.

from picogrid_ecn_client import load_config

Load a named non-secret profile with environment overrides.

def load_config(
    *,
    profile: str | None = None,
    environment: Mapping[str, str] | None = None,
) -> ECNConfig

Parameters

Name	Type	Default	Description
profile	str | None	None	Optional profile name to load.
environment	Mapping[str, str] | None	None	Optional environment mapping, primarily for controlled callers and tests. Defaults to the process environment.

Returns

Type	Description
ECNConfig	Validated immutable configuration for one MQTT v5 connection.

Raises

Exception	Description
ConfigurationError	If profile loading or configuration validation fails.

Source · config.py