Skip to main content

Satori Protocol SDK for python

Project description

satori-python

latest release Licence PyPI PyPI - Python Version

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

协议介绍

Satori Protocol

协议端

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

使用该 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()

文档

请阅读 仓库文档

示例

架构

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


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-0.15.0.tar.gz (37.5 kB view details)

Uploaded Source

Built Distribution

satori_python-0.15.0-py3-none-any.whl (44.5 kB view details)

Uploaded Python 3

File details

Details for the file satori_python-0.15.0.tar.gz.

File metadata

  • Download URL: satori_python-0.15.0.tar.gz
  • Upload date:
  • Size: 37.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: pdm/2.19.3 CPython/3.10.12 Linux/6.5.0-1025-azure

File hashes

Hashes for satori_python-0.15.0.tar.gz
Algorithm Hash digest
SHA256 58a97fcc2b835d48c88d4892acdf85b4f3d1fb7367ff30966ae788f2294671a6
MD5 2bb14ee1892330b42a2acafb96dabad6
BLAKE2b-256 4260beb7a452417e0335a6fc2ddcc1e8bc93067b17bd4889c598bab081bf35c4

See more details on using hashes here.

File details

Details for the file satori_python-0.15.0-py3-none-any.whl.

File metadata

  • Download URL: satori_python-0.15.0-py3-none-any.whl
  • Upload date:
  • Size: 44.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: pdm/2.19.3 CPython/3.10.12 Linux/6.5.0-1025-azure

File hashes

Hashes for satori_python-0.15.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c648b297b10defed0447569c2e22eff4c2b33dd0c52c359f4c292153b9990429
MD5 8afca399241dce6824686c416009ea3e
BLAKE2b-256 8243b67ec95760c781077e30da7a4bad267ea5bdbfe5f1f54e7d38297435c776

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page