Satori Protocol SDK for python, specify common part
Project description
satori-python
基于 Satori 协议的 Python 开发工具包
协议介绍
协议端
目前提供了 satori
协议实现的有:
- Chronocat
- Koishi (搭配
@koishijs/plugin-server
)
使用该 SDK 的框架
安装
安装完整体:
pip install satori-python
只安装基础部分:
pip install satori-python-core
只安装客户端部分:
pip install satori-python-client
只安装服务端部分:
pip install satori-python-server
使用
客户端:
from satori import EventType, WebsocketsInfo
from satori.event import MessageEvent
from satori.client import Account, App
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
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
satori_python_core-0.13.3.tar.gz
(16.3 kB
view hashes)
Built Distribution
Close
Hashes for satori_python_core-0.13.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20f2d09f15c4294e91cba9528fd6f70792ce7cb181f74cf9e0df22b1d1a91baf |
|
MD5 | f4b0db651674412b173445cbd9df3f88 |
|
BLAKE2b-256 | 90bafc6e895f832a3c5b85648fed5d5254e2c3216340d4e5d68fe5c6fd877346 |
Close
Hashes for satori_python_core-0.13.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 30d85a0acf69ed9d7628278be32208f78d1b7f393ee73a56c19c77ffe89d6687 |
|
MD5 | 31f8a6b731bd1a2b72fbe94ccd5911ad |
|
BLAKE2b-256 | ccdbac69b9155e522a1bfe584bb9040b8f84b1e03b439818671a04892201dd28 |