Skip to main content

Official Python SDK for the Larkup API

Project description

Larkup Python SDK

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

Install

pip install larkup

Use

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 for the complete guide.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

larkup-0.1.29.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

larkup-0.1.29-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

Details for the file larkup-0.1.29.tar.gz.

File metadata

  • Download URL: larkup-0.1.29.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.15

File hashes

Hashes for larkup-0.1.29.tar.gz
Algorithm Hash digest
SHA256 8b924bccabb7abf6ce8e4a96a572875981bb08bd2b793c19f9ae0dd92bb33b74
MD5 d3676b2a14429976e307c7ecc3e7e2f6
BLAKE2b-256 7f25d93817f657b7cd1fe73039404b57a11b5048dad18e6503a37bcd035d7318

See more details on using hashes here.

File details

Details for the file larkup-0.1.29-py3-none-any.whl.

File metadata

  • Download URL: larkup-0.1.29-py3-none-any.whl
  • Upload date:
  • Size: 8.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.15

File hashes

Hashes for larkup-0.1.29-py3-none-any.whl
Algorithm Hash digest
SHA256 048dfc5ae9650dc05482bb468eee4c0ac900d9c8c6ed1324c4f062149396dae9
MD5 b7e43d91c5ec93a77cbf7fafbea1d37e
BLAKE2b-256 6162133ec7e398c2d580571ca76e20f1cb661940a94e87e4f627bf53f4f76a37

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page