This release has been yanked by its maintainers, and will be ignored by installers, except when explicitly specified.
Consider using release 1.3.9.post1 instead.
Reason given by maintainers: bug
satori-python
基于 Satori 协议的 Python 开发工具包
协议介绍
协议端
目前提供了 satori 协议实现的有：
使用该 SDK 的框架
安装
安装完整体：
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 |
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
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file satori_python-1.3.9.tar.gz.
File metadata
- Download URL: satori_python-1.3.9.tar.gz
- Upload date:
- Size: 47.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
pdm/2.28.0 CPython/3.12.3 Linux/6.17.0-1020-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8e3ed308ffc599bdc116af91d0dd4ab43b8c89a2180d10e708af753821c49ff4
|
|
| MD5 |
d592fae4c4aafdcde9b832d43b63f2f1
|
|
| BLAKE2b-256 |
3af26534144dfda16605124b3d8ae6194523440ceca795c19c4dcdf16692cd22
|
File details
Details for the file satori_python-1.3.9-py3-none-any.whl.
File metadata
- Download URL: satori_python-1.3.9-py3-none-any.whl
- Upload date:
- Size: 54.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
pdm/2.28.0 CPython/3.12.3 Linux/6.17.0-1020-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2eb1d8b9289648ce4570398015c1913fa3e83d1a0c06e3f3c9386f64ff44924e
|
|
| MD5 |
32481c6e0e16d70868079b6f7ef9e4de
|
|
| BLAKE2b-256 |
04759fc283ec275caf1cfa36a5ae58651b8f685e22dbfd25f0de17b4458e537e
|
