settings_read()

Read the project settings, with environment sections and split files resolved.

Usage

settings_read(
    settings_file: str | Path | None = None,
    environment: str | None = None,
) -> dict[str, Any]

Name	Type	Default	Description
settings_file	str \| Path \| None	None	The settings file. Default: settings.yml (or config.yml) in the current folder or the nearest parent folder that has one.
environment	str \| None	None	The environment section to merge over `default`. Default: `active_environment()`.

The settings as a dict. The data, connections, git, security, packages, directories, and options sections are always present.