Home

clappform-python

Python client for the Clappform gRPC APIs. Version 6 is a ground-up rewrite: the full API surface is generated from the shared commons proto definitions, with a hand-written ergonomic layer for DataFrame workflows, multi-cluster configuration, and typed errors.

Status: under active development on the Major/6 branch. The published 4.x/5.x packages are unrelated to this codebase.

Start here

• Design — the canonical v6 design spec (architecture, public API, codegen, multi-cluster, auth, DataFrame flows, packaging). Issues link into this page by section.
• Roadmap & Status — phased implementation order and where each piece stands.
• Architecture — the one-screen mental model: how a call travels from cf.data.insert.insert_single(...) to the wire.
• Code Generation — how the client is generated from the proto repo and stays in sync.
• Contributing — dev setup, regeneration, tests, branch and PR conventions.
• Glossary — cluster vs. location, family vs. service, and the other terms used throughout.

Quick orientation

from clappform import Clappform

cf = Clappform(location="acme")          # cluster discovered from DNS
df = cf.data.collection("orders").read(where={"status": "open"})
apps = cf.client.app.get_all()

One package, one Clappform client, four API families (cf.data / cf.client / cf.auth / cf.notifier) — see Design §3.