Skip to content

load_config


function backtide.config.load_config(path)

Load a backtide configuration from a file.

Use this function to update a configuration programmatically before updating the current config with set_config. The accepted file formats are: toml, yaml, yml, json. Read more in the user guide.

Parameters

path: str

Location of the config file to load.

Returns

Config

The loaded configuration.


See Also

get_config

Get a copy of the current global configuration.

set_config

Set the global configuration.


Example

>>> from backtide.config import load_config, set_config

>>> # Use the configuration from a custom file location
>>> set_config(load_config("path/to/config.toml"))