Satori Protocol SDK for python, specify server part
Project description
satori-python
基于 Satori 协议的 Python 开发工具包
协议介绍
协议端
目前提供了 satori
协议实现的有:
- Chronocat
- Koishi (搭配
@koishijs/plugin-server
)
安装
安装完整体:
pip install satori-python
只安装基础部分:
pip install satori-python-core
只安装客户端部分:
pip install satori-python-client
只安装服务端部分:
pip install satori-python-server
使用
客户端:
from satori import Event, WebsocketsInfo
from satori.client import Account, App
app = App(WebsocketsInfo(port=5140))
@app.register
async def on_message(account: Account, event: Event):
if event.user and 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
Project details
Release history Release notifications | RSS feed
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
Close
Hashes for satori_python_server-0.10.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4e774bb5d8d6ad52710239b32de805e62452176d706a5b0f5c651bd83a1ed0e9 |
|
MD5 | 4426dc9cde60201b0e786fce4122affe |
|
BLAKE2b-256 | b2cb84f41834263a902dcc9db9a33708d06a091cc971d05df3452848ba9e57bf |
Close
Hashes for satori_python_server-0.10.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1abb3a32336af5eded9f487cc0a417b9707730c170c0d0e3bddd15d7e6258838 |
|
MD5 | 204351c0443da8702b1e02c5c6057e04 |
|
BLAKE2b-256 | ba74a3d2f4703ffc3c5c53aeecfb46de5fc6baf46ffddd6d8d543cade2259afe |