Metadata-Version: 2.4
Name: larkup
Version: 0.1.29
Summary: Official Python SDK for the Larkup API
Keywords: rag,retrieval-augmented-generation,larkup,ai,sdk
Author: Abdelrahman
Author-email: Abdelrahman <abdelrahmanaboneda@gmail.com>
License-Expression: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Dist: httpx>=0.28.1
Requires-Dist: pydantic>=2.13.4
Requires-Python: >=3.10
Project-URL: Homepage, https://larkup.de
Project-URL: Documentation, https://larkup.de/docs
Project-URL: Repository, https://github.com/Larkup-AI/larkup-rag
Description-Content-Type: text/markdown

# Larkup Python SDK

The synchronous and asynchronous Python clients for a generated Larkup server.

## Install

```bash
pip install larkup
```

## Use

```python
from larkup import LarkupClient, LarkupClientOptions

client = LarkupClient(
    LarkupClientOptions(
        base_url="http://localhost:8080",
        api_key="your-api-key",
    )
)

result = client.query("What is Larkup?", top_k=5)

for event in client.chat("Summarize the result."):
    if event.type == "text-delta":
        print(event.text or "", end="", flush=True)
```

The SDK supports health and OpenAPI discovery, retrieval, document CRUD, sequential or parallel bulk indexing with progress, corpus filtering and export, scraping, and streaming chat grounded in retrieved content. `AsyncLarkupClient` provides matching asynchronous methods.

`LarkupHubClient` and `AsyncLarkupHubClient` provide typed Marketplace catalog discovery. Install and uninstall operations remain in the CLI because they change the local Larkup tool directory.

See the [Python SDK documentation](https://larkup.de/docs/sdk/python) for the complete guide.
