Skip to content

docs: point the Hotdata CLI links at hotdata-cli; flag the HOTDATA_* env-var divergence - #94

Merged
eddietejeda merged 1 commit into
mainfrom
docs/readme-accuracy
Sep 10, 2026
Merged

eddietejeda merged 1 commit into
mainfrom
docs/readme-accuracy

Conversation

@eddietejeda

@eddietejeda eddietejeda commented Sep 10, 2026 •

Copy link
Copy Markdown
Contributor

README accuracy audit against source at v0.16.0 (same flow as hotdata-dev/hotdata-ibis#55).

  • Both "Hotdata CLI" links pointed at sdk-python, which ships no console script; the CLI lives in hotdata-cli. The three CLI commands shown were verified against hotdata-cli's clap definitions.

Flagged, not fixed — needs a maintainer call: the Configuration table's env column lists plain HOTDATA_* vars, but the destination never reads them — they're consumed only by config.py:from_env(), whose sole user is the diagnostic CLI, with defaults that disagree with the destination's. Verified empirically: HOTDATA_DATABASE_ID/HOTDATA_SCHEMA/HOTDATA_MAX_RETRIES don't reach the resolved config; DESTINATION__HOTDATA__* forms do. Only HOTDATA_API_KEY (explicit bridge in factory.py) and DESTINATION__HOTDATA__MAX_STATE_FILES work as documented. Since the changelog, runtime log, runbook, and .env.example all assert the plain-var contract, the likely fix is wiring them up in code rather than re-speccing the docs — so this PR reports it instead of rewriting the table.

Everything else in the README verified against source.

Both "Hotdata CLI" links (Requirements, Verify a load) pointed at
hotdata-dev/sdk-python, which ships no console script — the hotdata
CLI lives in hotdata-dev/hotdata-cli. The commands the README shows
(databases list, databases tables list --database, query -d) are all
hotdata-cli commands.
@eddietejeda
eddietejeda requested a review from a team as a code owner September 10, 2026 03:07
@eddietejeda
eddietejeda requested review from rohan-hotdata and removed request for a team September 10, 2026 03:07

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both "Hotdata CLI" links now point at hotdata-dev/hotdata-cli. The Resources list at README.md:516 still links the Python SDK separately, so the two references stay distinct. The HOTDATA_* env-var divergence described in the PR body is out of scope for this docs-only change.

@eddietejeda
eddietejeda merged commit 51eef05 into main Sep 10, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant