Metadata-Version: 2.4
Name: qari-sdk
Version: 0.1.0
Summary: Official Python SDK for the Qari document intelligence API
Author-email: VoltStack <dev@voltstack.tech>
License: MIT
Keywords: ocr,document-intelligence,sdk,qari
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: httpx<1.0,>=0.25
Requires-Dist: pydantic<3.0,>=2.0
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-asyncio; extra == "dev"
Requires-Dist: respx; extra == "dev"

# Qari Python SDK

Official Python SDK for the **Qari** document intelligence API.

## Installation

```bash
pip install qari
```

## Quick Start

```python
from qari import Qari

client = Qari(api_key="qari_your_api_key", base_url="https://api.qari.voltstack.tech")

# Upload & OCR a document
doc = client.documents.upload("invoice.pdf")
ocr = client.ocr.run_existing(doc.document_id)

# Chat with the document
answer = client.chat.ask(doc.document_id, "What is the total amount?")
print(answer.reply)

# Summarize
summary = client.summarization.summarize(doc.document_id, summary_type="executive_brief")
print(summary.content)
```

## Authentication

All requests are authenticated via API keys. Generate one from the Qari dashboard or via the API Keys endpoint.

## Available Modules

| Module | Description |
|---|---|
| `client.documents` | Upload, list, delete documents |
| `client.ocr` | Run OCR pipelines & retrieve outputs |
| `client.history` | Browse past OCR results |
| `client.chat` | Ask questions about documents |
| `client.summarization` | Generate & export summaries |
| `client.billing` | Plans, subscriptions, credits |
| `client.team` | Team members & invitations |
| `client.ingestion` | Import from URL, email, S3, GDrive, SharePoint |
| `client.dashboard` | Notifications, balance, usage stats |
| `client.api_keys` | Manage API keys |
| `client.payments` | Payment transactions & status |

## Async Support

```python
import asyncio
from qari import AsyncQari

async def main():
    client = AsyncQari(api_key="qari_...", base_url="https://api.qari.voltstack.tech")
    docs = await client.documents.list()
    await client.close()

asyncio.run(main())
```
