Skip to main content
Use the Braven client when you want to read data that’s already in the app — pull a file into pandas, list experiments in a project, or check metadata — rather than log new results.

Braven(url, api_key, timeout=30)

str
required
Backend URL — https://api.bravenlab.com.
str
Your braven_... Watcher Key.
int
default:"30"
Request timeout in seconds.

Methods

→ list[ExperimentSummary]
Lightweight summaries of every experiment you have access to — id, name, notes, created_at, file_count, metadata.
→ Experiment | list[Experiment]
Fetch one or more experiments by partial, case-insensitive name match. Pass a list[str] to fetch several at once. Raises ValueError if a name matches zero or more than one experiment — make the name more specific rather than guessing.

Experiment

fields
Basic experiment metadata.
dict[str, str | None]
Every Config and Summary value, keyed by name.
list[BravenFile]
Every file attached to the experiment.
→ BravenFile
Look up one file by exact filename. Raises FileNotFoundError (with the available filenames listed) if there’s no exact match.

BravenFile

→ bytes
Download and return the raw file content.
→ None
Download and write to a local path.
→ pandas.DataFrame
Parse as CSV. Requires pandas; raises ValueError if the filename isn’t .csv.

Full cheat sheet