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.30.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.30-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: larkup-0.1.30.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.30.tar.gz
Algorithm Hash digest
SHA256 4e026e45bfc2caa7f7dd78c0ae5f03609201227ad9f38c7baa85b64fd916bcfd
MD5 b79400437e8dab0ecf528d3a057d5a19
BLAKE2b-256 dbae29f925595dce3057a23e579e05bf9fe6cb3f46ae42bbb9409570fb4d5271

See more details on using hashes here.

File details

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

File metadata

  • Download URL: larkup-0.1.30-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.30-py3-none-any.whl
Algorithm Hash digest
SHA256 37f06315ab73787ef2c1959cbd0d75586a509a214426878c69d2954d5dbfbd5a
MD5 b6f3843048e0d52288a18f827927c6f6
BLAKE2b-256 100391e67f63eeaa926b585ca3fc809bf46693d2263a08942f4d2ed9e5ee6958

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