weflow-sdk

Typed Python client for weflow-server — a headless, read-only HTTP/SSE service over local WeChat 4.x chat databases.

Generated from the server's OpenAPI description (types + request plumbing), with a handwritten behavior layer on top: transport failures folded into a proper error tree, readiness polling, pagination helpers, SSE streaming, and media download helpers.

Install

pip install weflow-sdk

Minimal example

import asyncio

from weflow_sdk import Client


async def main() -> None:
    client = Client(base_url="http://127.0.0.1:5033", token="your-token")
    await client.health()
    sessions = await client.list_all_sessions()
    await client.aclose()


asyncio.run(main())

Need synchronous code? SyncClient mirrors Client method-for-method and drives its own private event-loop thread — it neither hijacks nor requires a loop in your thread:

from weflow_sdk import SyncClient

with SyncClient(base_url="http://127.0.0.1:5033", token="your-token") as client:
    client.health()
    sessions = client.list_all_sessions()

watch_* returns a plain iterator with the same reconnect-replay semantics as the async side.

Scope

The server exposes a strictly read-only surface: accounts, sessions, messages, contacts, group members, SNS timelines, media export, and an SSE push stream. This client covers all of it except the SNS timelines — the server has those endpoints, the generated layer does not wrap them yet, so reach for plain HTTP if you need them (the gap is deliberate, not silent: the contract pins the surface this client is tested against). See the server repository for the API reference.

License

MIT