Skip to content

docs(config): document the robinhood probe's key names in .env.example - #219

Merged
eaitbrahim merged 1 commit into
mainfrom
docs/env-example-robinhood-keys
Aug 9, 2026
Merged

docs(config): document the robinhood probe's key names in .env.example#219
eaitbrahim merged 1 commit into
mainfrom
docs/env-example-robinhood-keys

Conversation

@eaitbrahim

Copy link
Copy Markdown
Contributor

scripts/robinhood_smoke.py (#216) has required ROBINHOOD_API_KEY and ROBINHOOD_PRIVATE_KEY since it landed, and #218 exercised it against the live venue twice, but neither PR added the names to .env.example. The only record of what to put in .env was the script's own failure message — which you only see after you already went looking.

What changed

Two names and a four-line comment in .env.example. Nothing executable.

Why the comment carries its weight

  • Probe-only is the load-bearing fact. load_secrets does not read these. A reader who fills them in and expects the Robinhood adapter to come alive in a run has misread the state of the package. The adapter README says so at length; this is the one-line version at the point of use.
  • The seed encoding is called out because a PEM is the likelier guess, and getting it wrong fails with a character-length error that never names the cause.

Verification

  • uv run pytest tests/broker_robinhood tests/scripts/test_robinhood_smoke.py -q167 passed (unchanged; this PR touches no code).
  • Claims checked against source, not memory: the probe-only status against packages/keel-broker-robinhood/README.md:121-122, the seed encoding against scripts/robinhood_smoke.py:191.

🤖 Generated with Claude Code

`scripts/robinhood_smoke.py` (#216) has required `ROBINHOOD_API_KEY` and
`ROBINHOOD_PRIVATE_KEY` since it landed, and #218 exercised it against the live
venue twice, but neither PR added the names to `.env.example` -- so the only
record of what to put in `.env` was the script's own failure message, which you
see after you already went looking.

Both are commented as probe-only on purpose. `load_secrets` does not read them,
so a reader who fills them in and expects the adapter to come alive in a run has
misread the state of this package; the README says the same thing at length and
this is the one-line version at the point of use. The seed encoding is called
out because a PEM is the likelier guess and fails with a length error rather
than anything that names the cause.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@eaitbrahim
eaitbrahim merged commit 44c01c4 into main Aug 9, 2026
1 check passed
@eaitbrahim
eaitbrahim deleted the docs/env-example-robinhood-keys branch August 9, 2026 23:30
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