feat(config): default api_key, workspace_id and host from the environment

Configuration() now reads HOTDATA_API_KEY, HOTDATA_WORKSPACE and
HOTDATA_API_URL when the matching argument is None, the same variables
the CLI honours. Explicit arguments win; an empty variable is unset. The
change lives in the mustache template the generator uses for
configuration.py, so a regen keeps it.

Author: eddietejeda

.openapi-generator-templates/configuration.mustache

@@ -9,6 +9,7 @@ import logging
 from logging import FileHandler
 {{^async}}
 import multiprocessing
+import os
 {{/async}}
 import sys
 from importlib.metadata import PackageNotFoundError, version as _pkg_version
@@ -156,13 +157,16 @@ class HostSetting(TypedDict):
 class Configuration:
     """This class contains various settings of the API client.
 
-    :param host: Base url.
+    :param host: Base url. Defaults to the `HOTDATA_API_URL` environment
+      variable when set, else `https://api.hotdata.dev`.
     :param ignore_operation_servers
       Boolean to ignore operation servers for the API client.
       Config will use `host` as the base url regardless of the operation servers.
     :param api_key: Hotdata API key, sent as `Authorization: Bearer <key>`.
+      Defaults to the `HOTDATA_API_KEY` environment variable when not given.
     :param workspace_id: Public id of the target workspace, sent as
-      `X-Workspace-Id`.
+      `X-Workspace-Id`. Defaults to the `HOTDATA_WORKSPACE` environment
+      variable when not given.
     :param api_keys: Escape hatch for raw apiKey-scheme values, keyed by
       security scheme name. Prefer `workspace_id`.
     :param api_key_prefix: Dict to store API prefix (e.g. Bearer).
@@ -299,6 +303,14 @@ conf = {{packageName}}.Configuration(
     ) -> None:
         """Constructor
         """
+        # Environment defaults, matching the Hotdata CLI: an explicit argument
+        # always wins; an unset or empty variable leaves the default in place.
+        if api_key is None:
+            api_key = os.environ.get("HOTDATA_API_KEY") or None
+        if workspace_id is None:
+            workspace_id = os.environ.get("HOTDATA_WORKSPACE") or None
+        if host is None:
+            host = os.environ.get("HOTDATA_API_URL") or None
         self._base_path = "{{basePath}}" if host is None else host
         """Default Base url
         """

CHANGELOG.md

@@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- `hotdata.Configuration` reads `HOTDATA_API_KEY`, `HOTDATA_WORKSPACE` and
+  `HOTDATA_API_URL` from the environment when `api_key`, `workspace_id` or
+  `host` is not passed, matching the CLI. Explicit arguments always win and an
+  empty variable counts as unset.
 - `DatabasesApi.load_database_table` and `ConnectionsApi.load_managed_table`
   (the classes exported from `hotdata`) retry automatically while another load
   holds the table: HTTP 409 with error code `RESOURCE_LOCKED` is retried,

README.md

@@ -37,7 +37,13 @@ configuration = hotdata.Configuration(
 )
 ```
 
-`host` defaults to `https://api.hotdata.dev`. Override it if you target another environment.
+Each of these can come from the environment instead, the same variables the
+CLI uses: `HOTDATA_API_KEY`, `HOTDATA_WORKSPACE` and `HOTDATA_API_URL` fill in
+`api_key`, `workspace_id` and `host` when the argument is not passed. An
+explicit argument always wins.
+
+`host` defaults to `https://api.hotdata.dev`. Override it (or set
+`HOTDATA_API_URL`) if you target another environment.
 
 ## Usage
 

hotdata/configuration.py

@@ -16,6 +16,7 @@
 import logging
 from logging import FileHandler
 import multiprocessing
+import os
 import sys
 from importlib.metadata import PackageNotFoundError, version as _pkg_version
 from typing import Any, ClassVar, Dict, List, Literal, Optional, TypedDict, Union
@@ -135,13 +136,16 @@ class HostSetting(TypedDict):
 class Configuration:
     """This class contains various settings of the API client.
 
-    :param host: Base url.
+    :param host: Base url. Defaults to the `HOTDATA_API_URL` environment
+      variable when set, else `https://api.hotdata.dev`.
     :param ignore_operation_servers
       Boolean to ignore operation servers for the API client.
       Config will use `host` as the base url regardless of the operation servers.
     :param api_key: Hotdata API key, sent as `Authorization: Bearer <key>`.
+      Defaults to the `HOTDATA_API_KEY` environment variable when not given.
     :param workspace_id: Public id of the target workspace, sent as
-      `X-Workspace-Id`.
+      `X-Workspace-Id`. Defaults to the `HOTDATA_WORKSPACE` environment
+      variable when not given.
     :param api_keys: Escape hatch for raw apiKey-scheme values, keyed by
       security scheme name. Prefer `workspace_id`.
     :param api_key_prefix: Dict to store API prefix (e.g. Bearer).
@@ -203,6 +207,14 @@ def __init__(
     ) -> None:
         """Constructor
         """
+        # Environment defaults, matching the Hotdata CLI: an explicit argument
+        # always wins; an unset or empty variable leaves the default in place.
+        if api_key is None:
+            api_key = os.environ.get("HOTDATA_API_KEY") or None
+        if workspace_id is None:
+            workspace_id = os.environ.get("HOTDATA_WORKSPACE") or None
+        if host is None:
+            host = os.environ.get("HOTDATA_API_URL") or None
         self._base_path = "https://api.hotdata.dev" if host is None else host
         """Default Base url
         """

tests/test_config_env.py

@@ -0,0 +1,104 @@
+"""`Configuration` reads credentials and host from the environment.
+
+The CLI already honours `HOTDATA_API_KEY`, `HOTDATA_WORKSPACE` and
+`HOTDATA_API_URL`; the SDK now does the same when the matching constructor
+argument is `None`. Explicit arguments always win, and an empty variable
+counts as unset. `Configuration` is generated from the in-repo mustache
+template, so the template is checked for the same wiring.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import pytest
+
+from hotdata import ApiClient, Configuration
+from hotdata.api.workspaces_api import WorkspacesApi
+
+REPO_ROOT = Path(__file__).resolve().parents[1]
+TEMPLATE = REPO_ROOT / ".openapi-generator-templates" / "configuration.mustache"
+
+ENV_VARS = ("HOTDATA_API_KEY", "HOTDATA_WORKSPACE", "HOTDATA_API_URL")
+
+
+@pytest.fixture(autouse=True)
+def _clean_env(monkeypatch: pytest.MonkeyPatch) -> None:
+    for name in ENV_VARS:
+        monkeypatch.delenv(name, raising=False)
+
+
+def test_defaults_without_env() -> None:
+    cfg = Configuration()
+    assert cfg.api_key is None
+    assert cfg.workspace_id is None
+    assert cfg.host == "https://api.hotdata.dev"
+
+
+def test_env_fills_in_missing_args(monkeypatch: pytest.MonkeyPatch) -> None:
+    monkeypatch.setenv("HOTDATA_API_KEY", "hd_env_key")
+    monkeypatch.setenv("HOTDATA_WORKSPACE", "ws_env")
+    monkeypatch.setenv("HOTDATA_API_URL", "https://api.example.test")
+    cfg = Configuration()
+    assert cfg.api_key == "hd_env_key"
+    assert cfg.workspace_id == "ws_env"
+    assert cfg.host == "https://api.example.test"
+    # The env-provided values reach the wire exactly like explicit ones.
+    auth = cfg.auth_settings()
+    assert auth["BearerAuth"]["value"] == "Bearer hd_env_key"
+    assert auth["WorkspaceId"]["value"] == "ws_env"
+
+
+def test_explicit_args_win_over_env(monkeypatch: pytest.MonkeyPatch) -> None:
+    monkeypatch.setenv("HOTDATA_API_KEY", "hd_env_key")
+    monkeypatch.setenv("HOTDATA_WORKSPACE", "ws_env")
+    monkeypatch.setenv("HOTDATA_API_URL", "https://env.example.test")
+    cfg = Configuration(
+        api_key="hd_arg_key", workspace_id="ws_arg", host="https://arg.example.test"
+    )
+    assert cfg.api_key == "hd_arg_key"
+    assert cfg.workspace_id == "ws_arg"
+    assert cfg.host == "https://arg.example.test"
+
+
+def test_empty_env_counts_as_unset(monkeypatch: pytest.MonkeyPatch) -> None:
+    for name in ENV_VARS:
+        monkeypatch.setenv(name, "")
+    cfg = Configuration()
+    assert cfg.api_key is None
+    assert cfg.workspace_id is None
+    assert cfg.host == "https://api.hotdata.dev"
+
+
+def test_env_host_is_used_for_requests(monkeypatch: pytest.MonkeyPatch) -> None:
+    monkeypatch.setenv("HOTDATA_API_URL", "https://env.example.test")
+    monkeypatch.setenv("HOTDATA_API_KEY", "hd_env_key")
+    client = ApiClient(Configuration())
+    method, url, headers, _body, _post = WorkspacesApi(client)._list_workspaces_serialize(
+        organization_public_id=None,
+        _request_auth=None,
+        _content_type=None,
+        _headers=None,
+        _host_index=0,
+    )
+    assert method == "GET"
+    assert url.startswith("https://env.example.test/v1/workspaces")
+    assert headers["Authorization"] == "Bearer hd_env_key"
+
+
+def test_env_is_read_per_instance(monkeypatch: pytest.MonkeyPatch) -> None:
+    # Resolved at construction, not at import: a later change to the
+    # environment affects only configurations built after it.
+    monkeypatch.setenv("HOTDATA_API_KEY", "first")
+    first = Configuration()
+    monkeypatch.setenv("HOTDATA_API_KEY", "second")
+    second = Configuration()
+    assert (first.api_key, second.api_key) == ("first", "second")
+
+
+def test_template_carries_the_same_env_defaults() -> None:
+    # configuration.py is regenerated from this template; the env wiring must
+    # live there too or the next regen silently drops it.
+    src = TEMPLATE.read_text()
+    for name in ENV_VARS:
+        assert f'os.environ.get("{name}")' in src