Installation

humanbaselines requires Python 3.10+ and depends only on requests and pydantic.

pip install humanbaselines

Until it's published to PyPI, install from the repository:

pip install "git+https://github.com/valgorithmic/humanbaselines.git#subdirectory=clients/python"
# or, from a checkout:
pip install clients/python

Authentication

Every call needs an API key. Set it via the HUMANBASELINES_API_KEY environment variable (or pass api_key=...) and the client sends it automatically:

export HUMANBASELINES_API_KEY="hbk_..."

from humanbaselines import HumanBaselines

hb = HumanBaselines()   # key read from the environment

See API access for how to request a key and the full details.

Base URL

By default the client talks to https://humanbaselines.com, which proxies the /v1/* endpoints. You usually don't need to change this. See the client reference for base_url, timeout, and retry options (and the one caveat about health()).

Verify

hb = HumanBaselines()
print(hb.regions())                 # regions + modes this server offers
print(hb.filters().modes.keys())    # dict_keys(['geofence', 'route', 'depot'])

Then head to the Quickstart.