satori-python

latest release

基于 Satori 协议的 Python 开发工具包

协议介绍

Satori Protocol

协议端

目前提供了 satori 协议实现的有：

Chronocat
LLBot
nekobox
Koishi （搭配 @koishijs/plugin-server）

使用该 SDK 的框架

Entari

安装

安装完整体：

pip install satori-python

只安装基础部分：

pip install satori-python-core

只安装客户端部分：

pip install satori-python-client

只安装服务端部分：

pip install satori-python-server

官方适配器

适配器	安装	路径
Satori	`pip install satori-python-adapter-satori`	satori.adapters.satori
OneBot V11	`pip install satori-python-adapter-onebot11`	satori.adapters.onebot11.forward, satori.adapters.onebot11.reverse
Console	`pip install satori-python-adapter-console`	satori.adapters.console
Milky	`pip install satori-python-adapter-milky`	satori.adapters.milky.main, satori.adapters.milky.webhook, satori.adapters.milky.sse
QQ	`pip install satori-python-adapter-qq`	satori.adapters.qq.main, satori.adapters.qq.websocket

社区适配器

适配器	安装	路径
nekobox(Lagrange)	`pip install nekobox`	nekobox.main

使用

客户端：

from satori import EventType
from satori.event import MessageEvent
from satori.client import Account, App, WebsocketsInfo

app = App(WebsocketsInfo(port=5140))

@app.register_on(EventType.MESSAGE_CREATED)
async def on_message(account: Account, event: MessageEvent):
    if event.user.id == "xxxxxxxxxxx":
        await account.send(event, "Hello, World!")

app.run()

服务端：

from satori import Api
from satori.server import Server

server = Server(port=5140)

@server.route(Api.MESSAGE_CREATE)
async def on_message_create(*args, **kwargs):
    return [{"id": "1234", "content": "example"}]

server.run()

文档

请阅读仓库文档

示例

客户端：client.py
服务端：server.py
- 服务端(使用适配器)：server_with_adapter.py
客户端(webhook)：client_webhook
服务端(webhook)：server_webhook
适配器：adapter.py

架构

graph LR
    subgraph Server
        server -- run --> asgi
        server -- register --> router -- mount --> asgi
        server -- apply --> provider -- mount  --> asgi
        provider -- event,logins --> server
    end
    subgraph Client
        config -- apply --> app -- run --> network
        app -- register --> listener
        network -- account,event --> listener
        listener -- handle --> account -- session --> api
    end
    
    api -- request --> asgi -- response --> api
    server -- raw-event --> asgi -- websocket/webhook --> network

Metadata

Release files for satori-python 1.3.9.post1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for satori-python 1.3.9.post1
File	Size	Uploaded
satori_python-1.3.9.post1.tar.gz	47.4 kB	Jul 20, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for satori-python 1.3.9.post1
File	Interpreter	ABI	Platform	Reset
satori_python-1.3.9.post1-py3-none-any.whl 54.9 kB Jul 20, 2026	Python 3	none	any	Details

Total release size: 102.3 kB

Release files / satori_python-1.3.9.post1.tar.gz

Download URL	satori_python-1.3.9.post1.tar.gz
Size	47.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`4e255d441fda7ef3b21dd8cfe0e2120e5b6d331517c6ca356ee8ac364fb89f79`
BLAKE2b-256 checksum How to use checksums	`8a513f19829ddc4c4b5466fae59e8358720a36b6417fbf11a0d45d7cb5f63561`
Upload date	Jul 20, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`pdm/2.28.0 CPython/3.12.3 Linux/6.17.0-1020-azure`

Release files / satori_python-1.3.9.post1-py3-none-any.whl

Download URL	satori_python-1.3.9.post1-py3-none-any.whl
Size	54.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`1b6a6f8d504a1f07b1c29c4186a554dd111c2e7541b1e5f624338ac410091af2`
BLAKE2b-256 checksum How to use checksums	`1351ec481725cd23b9ee9b131cf9f2052b30117fa71658ac636ddf245fdeb471`
Upload date	Jul 20, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`pdm/2.28.0 CPython/3.12.3 Linux/6.17.0-1020-azure`