[jfrench9]

Summary

An audit found the facade README largely untrue, including a test command that doesn't exist, env vars nothing reads, and an example that builds invalid Cypher. This rewrites it from 634 to 263 lines around what the clients do, and corrects the main README's claims about streaming, async and errors. No code changes.

Changes

robosystems_client/clients/README.md (rewritten)

• Covers LedgerClient, InvestorClient, LibraryClient and the document client, which the old file didn't mention.
• Removes: run_tests.py, six ROBOSYSTEMS_* env vars, /health (it's GET /v1/status), company['name'], connection pooling, automatic caching, "full async throughout" and Python 3.7+.
• States limits plainly, so a reader doesn't find them the hard way:
  • stream_query collects the whole result before yielding.
  • CookieAuthClients doesn't authenticate.
  • get_clients() returns a client for localhost with no credential.
  • Two .where() calls produce invalid Cypher.
  • files.list, files.get, files.delete and tables.list hide errors.

README.md

• Streaming, async and error handling now match the code.

Worth a close look: this documents limits as they are. Each is a code question for a separate change, not something this PR decides.

Compatibility

None. Documentation only: no export, signature or runtime behavior changes, so no release is needed for code.

Testing

• The pre-commit checks passed, including tests (737 passed, 17 skipped).
• A throwaway script compiled all 11 Python blocks, ran their imports, and checked facade calls against inspect.signature.
• Mocked runs confirmed the QueryBuilder output, credential routing, max_wait=0 and NDJSON aggregation.
• Nothing ran against a live API, so row["e.name"] relies on the documented column keys, and e.ticker and e.sic values on sec weren't queried.

🤖 Generated with Claude Code