aquin.engine.main Namespace Reference

Functions
str	scrub_user_message (str text)
str	_base_url ()
dict	_load_state ()
None	_save_state (dict data)
str	resolve_api_key (*, bool allow_missing=False)
None	ensure_engine_auth_persisted ()
list[str]	format_engine_status_lines ()

Variables
str	_STATE_PATH = Path.home() / ".aquin" / "engine.json"
str	_BASE_URL_DEFAULT = "https://api.aquin.app"
	_API_URL_RE = re.compile(r"https?://api\.aquin\.app(?:/\S*)?")

Function Documentation

_base_url()

str _base_url ( )

protected

Definition at line 28 of file main.py.

Referenced by ensure_engine_auth_persisted().

_load_state()

dict _load_state ( )

protected

Definition at line 32 of file main.py.

Referenced by ensure_engine_auth_persisted(), and format_engine_status_lines().

_save_state()

None _save_state ( dict data )

protected

Definition at line 41 of file main.py.

Referenced by ensure_engine_auth_persisted().

ensure_engine_auth_persisted()

None ensure_engine_auth_persisted

(

)

Copy logged-in credentials into engine.json when missing.

Definition at line 52 of file main.py.

References _base_url(), _load_state(), _save_state(), and resolve_api_key().

format_engine_status_lines()

list[str] format_engine_status_lines

(

)

Account-adjacent engine state for `aquin status`.

Definition at line 66 of file main.py.

References _load_state().

resolve_api_key()

str resolve_api_key	(	*	,
		bool	allow_missing = False )

Saved login (config.json / env) :  never prompts interactively.

Definition at line 46 of file main.py.

Referenced by ensure_engine_auth_persisted().

scrub_user_message()

str scrub_user_message

(

str

text

)

Strip internal API host from strings shown in the terminal.

Definition at line 23 of file main.py.

Variable Documentation

_API_URL_RE

aquin.engine.main._API_URL_RE = re.compile(r"https?://api\.aquin\.app(?:/\S*)?")

protected

Definition at line 20 of file main.py.

_BASE_URL_DEFAULT

str aquin.engine.main._BASE_URL_DEFAULT = "https://api.aquin.app"

protected

Definition at line 19 of file main.py.

_STATE_PATH

str aquin.engine.main._STATE_PATH = Path.home() / ".aquin" / "engine.json"

protected

Definition at line 18 of file main.py.