settings — Quantstrip Docs

Quick usage

from quantstrip import settings

allocation = settings.get_by_path(
    "Settings/Strategy Settings/Monthly Flow Rebalancing/allocation"
)

Reading and writing

get_by_path(path)

The parsed, decrypted value at path. For an environment-backed node, returns the live OS environment value instead.

Returns the value, or None if the path does not exist.

set_by_path(path, value=None, value_type="text", source="direct", env_var="")

Sets (creating if needed) the setting at path. Pass source="env" and env_var to make it environment-backed instead of storing value directly.

get_raw_by_path(path)

The raw node — no parsing or decryption — useful for inspecting _type/_source/_env_var directly.

Returns a dict, or None.

get_env_var_status(path)

Whether an environment-backed setting's variable is actually set on the host.

Returns True/False, or None if the path isn't an environment-backed setting.

Tree structure

get_folder_children(path)

Names of the child folders/settings under path.

Returns List[str].

create_folder(parent_path, folder_name, locked=False)

Creates a folder node, optionally locked.

delete_folder(path) / delete_setting(path)

Deletes a folder or a leaf setting node.

folder_exists(path) / setting_exists(path)

Existence checks — bool.

is_locked(path)

Whether path, or any ancestor folder in its path, is locked.

Returns bool.

Module-level helper: get_env_var(name) — reads directly from the Windows registry (system, then user hive) rather than the process environment, so a value set on the host is picked up without restarting the Quantstrip service.