Skip to content

docs: rewrite the clients README against the code #290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jfrench9 merged 3 commits into from
Nov 1, 2026
Merged

docs: rewrite the clients README against the code #290

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0ee4660
docs: rewrite the clients README against the code
jfrench9 Nov 1, 2026
dafdc0c
docs(readme): correct the async and error-handling claims
jfrench9 Nov 1, 2026
57a3b70
docs(readme): drop async-ready from the summary line
jfrench9 Nov 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@
[![PyPI version](https://badge.fury.io/py/robosystems-client.svg)](https://pypi.org/project/robosystems-client/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Official Python client for the RoboSystems financial intelligence platform — accounting, financial reporting, and investment management over a knowledge graph API. Type-safe and async-ready, generated from the OpenAPI spec, with GraphQL reads and idempotent operation writes.
Official Python client for the RoboSystems financial intelligence platform — accounting, financial reporting, and investment management over a knowledge graph API. Type-safe, generated from the OpenAPI spec, with GraphQL reads and idempotent operation writes.

## Features

- **Type-safe API client** with full type hints and typed models
- **Async/await support** for high-performance applications
- **Async client** for queries and operations
- **Parquet file uploads** for table ingestion
- **Streaming support** for memory-efficient processing of large result sets
- **Row iteration** over query results with `stream_query`, which collects the full result before yielding rows
- **AI Operator** integration for natural language financial analysis
- **Comprehensive error handling** with typed exceptions
- **Typed errors** for GraphQL reads and queued work

## Installation

Expand Down
Loading
Loading