Skip to main content

Multi-platform async chat SDK for Python — port of Vercel Chat

Project description

chat-sdk-python

PyPI Python Tests License: MIT

Multi-platform async chat SDK for Python. Port of Vercel Chat.

Status: Alpha (0.4.26 — synced to Vercel Chat 4.26.0) — API may change.

Why chat-sdk?

  • Write once, deploy to 8 platforms. One handler runs on Slack, Discord, Teams, Telegram, WhatsApp, Google Chat, GitHub, and Linear.
  • Built-in concurrency primitives. Deduplication, thread locking, and message queuing are handled for you.
  • Cross-platform cards. Author a Card once and it renders as Block Kit (Slack), Adaptive Cards (Teams), embeds (Discord), and more.
  • Not a replacement for platform SDKs. chat-sdk is built on top of them. You can always drop down to the native SDK when you need to.

Install

pip install chat-sdk                   # core only
pip install chat-sdk[slack]            # + Slack adapter
pip install chat-sdk[all]              # all adapters + state backends

Quick Start

from chat_sdk import Chat, Card, Button, Actions, MemoryStateAdapter
from chat_sdk.adapters.slack import create_slack_adapter

chat = Chat(
    adapters={"slack": create_slack_adapter()},
    state=MemoryStateAdapter(),
    user_name="my-bot",
)

@chat.on_mention
async def handle_mention(thread, message):
    await thread.post(
        Card(title="Hello!", children=[
            Actions([Button(id="hi", label="Say Hi")])
        ])
    )

Adapters

Platform Install Extra Status
Slack chat-sdk[slack] Alpha
Discord chat-sdk[discord] Alpha
Teams chat-sdk[teams] Alpha
Telegram chat-sdk[telegram] Alpha
WhatsApp chat-sdk[whatsapp] Alpha
Google Chat chat-sdk[google-chat] Alpha
GitHub chat-sdk[github] Alpha
Linear chat-sdk[linear] Alpha

State Backends

Backend Install Extra
In-Memory Built-in
Redis chat-sdk[redis]
PostgreSQL chat-sdk[postgres]

Compared to Alternatives

Feature chat-sdk Raw platform SDKs BotFramework SDK
Multi-platform from one codebase 8 platforms 1 per SDK Teams + limited
Async-native (Python 3.10+) Yes Varies No
Cross-platform cards Card model Platform-specific Adaptive Cards only
Thread locking / dedup Built-in DIY DIY
State abstraction (mem/redis/pg) Built-in DIY DIY
Drop down to native SDK Yes N/A Partially

Documentation

Document Description
Architecture Module dependency graph, adapter protocol, card system, concurrency strategies, state backends, markdown pipeline, streaming pipeline
Upstream Sync How to keep the Python port in sync with the Vercel Chat TS SDK, translation patterns, known footguns
Security Webhook verification per platform, SSRF protections, crypto details, known limitations, production audit checklist
Testing Test categories, how to run tests, how to add adapter tests, coverage gaps, dispatch key validation
Design Decisions Rationale for key architectural choices (hand-rolled parser, PascalCase builders, global singleton, zero deps)
Contributing Dev setup, code quality, PR expectations
Changelog Release history

Development

uv sync --group dev
uv run pytest tests/
uv run ruff check src/

License

MIT

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

chat_sdk-0.4.26.2.tar.gz (660.0 kB view details)

Uploaded Source

Built Distribution

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

chat_sdk-0.4.26.2-py3-none-any.whl (294.5 kB view details)

Uploaded Python 3

File details

Details for the file chat_sdk-0.4.26.2.tar.gz.

File metadata

  • Download URL: chat_sdk-0.4.26.2.tar.gz
  • Upload date:
  • Size: 660.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for chat_sdk-0.4.26.2.tar.gz
Algorithm Hash digest
SHA256 f504413c139454323dc34ccc13a31ac6a0c44e1a737032ca07a0dc7ba90afa92
MD5 972e58ba33fb6b70551b8e9a0d8de921
BLAKE2b-256 ffab499af3dd665d1906e622c99d86278dfec4cb10a16578e75681af37c482a6

See more details on using hashes here.

Provenance

The following attestation bundles were made for chat_sdk-0.4.26.2.tar.gz:

Publisher: publish.yml on Chinchill-AI/chat-sdk-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file chat_sdk-0.4.26.2-py3-none-any.whl.

File metadata

  • Download URL: chat_sdk-0.4.26.2-py3-none-any.whl
  • Upload date:
  • Size: 294.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for chat_sdk-0.4.26.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5fe12d44aebeeab722711de6aafdb3384b75e57f3295029044ca7c501d6ce1a0
MD5 5541bb40396607e51c37130a273d6426
BLAKE2b-256 3929c82bb4afff9e13762dc6e704d80c224a9761f29e8739c0662b93bb7ba0bc

See more details on using hashes here.

Provenance

The following attestation bundles were made for chat_sdk-0.4.26.2-py3-none-any.whl:

Publisher: publish.yml on Chinchill-AI/chat-sdk-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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