Skip to content

Commit b1101e8

Browse files
kevin1chunclaude
andcommitted
docs: update README for polyglot monorepo + integration test instructions
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 3eaa88b commit b1101e8

File tree

1 file changed

+37
-4
lines changed

1 file changed

+37
-4
lines changed

README.md

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,19 @@
55
[![ClawHub](https://img.shields.io/badge/ClawHub-robinhood--for--agents-blue)](https://clawhub.ai/kevin1chun/robinhood-for-agents)
66
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
77

8-
Robinhood for AI agents — an MCP server with 18 structured tools and a standalone TypeScript client, in a single package.
8+
Robinhood for AI agents — polyglot monorepo with TypeScript + Python SDKs, an MCP server with 18 tools, and a local auth proxy.
99

1010
- **18 MCP tools** for any MCP-compatible AI agent
1111
- **Unified trading skill** for guided workflows (Claude Code, OpenClaw, [ClawHub](https://clawhub.ai/kevin1chun/robinhood-for-agents))
12-
- **Standalone API client** (~50 async methods) for programmatic use
12+
- **TypeScript + Python client libraries** (~50 async methods each) for programmatic use
13+
- **Auth proxy** — tokens stay in the OS keychain, never exposed to the agent
1314

1415
Compatible with **Claude Code**, **Codex**, **OpenClaw**, and any MCP-compatible agent.
1516

1617
## Prerequisites
1718

18-
- [Bun](https://bun.sh/) v1.0+
19+
- [Bun](https://bun.sh/) v1.0+ (TypeScript SDK)
20+
- [Python](https://www.python.org/) 3.12+ and [uv](https://docs.astral.sh/uv/) (Python SDK — optional)
1921
- Google Chrome (used by `playwright-core` for browser-based login — no bundled browser)
2022
- A Robinhood account
2123

@@ -42,7 +44,7 @@ robinhood-for-agents onboard --agent openclaw
4244

4345
```bash
4446
git clone https://github.com/kevin1chun/robinhood-for-agents.git
45-
cd robinhood-for-agents
47+
cd robinhood-for-agents/typescript
4648
bun install
4749
bun bin/robinhood-for-agents.ts onboard
4850
```
@@ -300,13 +302,44 @@ See [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for the full auth flow diagram
300302

301303
## Development
302304

305+
### TypeScript
306+
303307
```bash
308+
cd typescript
304309
bun install # Install deps
305310
bun run typecheck # tsc --noEmit
306311
bun run check # Biome lint + format
307312
npx vitest run # Run all tests
308313
```
309314

315+
### Python
316+
317+
```bash
318+
cd python
319+
uv sync --all-extras # Install deps
320+
uv run ruff check . # Lint
321+
uv run mypy src/ # Type check
322+
uv run pytest # Run all tests
323+
```
324+
325+
### Integration tests (verify local setup)
326+
327+
Integration tests hit the real Robinhood API (read-only) through the auth proxy. Use them to confirm your local dev environment is working end-to-end.
328+
329+
```bash
330+
# 1. Login (opens Chrome — one-time)
331+
robinhood-for-agents login
332+
333+
# 2. Start the auth proxy
334+
robinhood-for-agents proxy
335+
336+
# 3. Run integration tests
337+
cd typescript && bun run test:integration
338+
cd python && uv run pytest -m integration
339+
```
340+
341+
These are excluded from CI and the default test commands since they require real credentials.
342+
310343
## Architecture
311344

312345
See [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for full system design, authentication flow, HTTP pipeline, and exception hierarchy.

0 commit comments

Comments
 (0)