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: 0.4.27 — synced to upstream Vercel Chat 4.27.0 (release commit f55378a). See CHANGELOG.md for release notes and docs/UPSTREAM_SYNC.md for the known non-parity list.

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.27.tar.gz (805.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.27-py3-none-any.whl (348.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chat_sdk-0.4.27.tar.gz
  • Upload date:
  • Size: 805.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.27.tar.gz
Algorithm Hash digest
SHA256 b0c8214c1e034eccbc7c6f7e1cd7a19932815500cd62ad025a5280756f46a108
MD5 c5cdb06ac741d146e9634d3be9f6499d
BLAKE2b-256 b8b2012309ac0158ab2c4e92cca0a42bcc76b0e306929bfb870faf8a4061d1c0

See more details on using hashes here.

Provenance

The following attestation bundles were made for chat_sdk-0.4.27.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.27-py3-none-any.whl.

File metadata

  • Download URL: chat_sdk-0.4.27-py3-none-any.whl
  • Upload date:
  • Size: 348.9 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.27-py3-none-any.whl
Algorithm Hash digest
SHA256 7f70add46af4d7341b41d9ae9f3ea834a6d361ba2fc750611f93fc1e6361dd75
MD5 de2d1b5667a99d01aa54ca6acba53048
BLAKE2b-256 504fcf234d652d811b2ded1a40af0603341144cc3f20c8775dbd52eae0415aad

See more details on using hashes here.

Provenance

The following attestation bundles were made for chat_sdk-0.4.27-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