satori-python-adapter-qq 0.1.0__tar.gz

satori_python_adapter_qq-0.1.0/.mina/adapter_qq.toml

@@ -0,0 +1,32 @@
+includes = ["src/satori/adapters/qq"]
+raw-dependencies = [
+    "satori-python >= 0.18.0",
+    "crypography>=46.0.4",
+]
+
+[project]
+name = "satori-python-adapter-qq"
+version = "0.1.0"
+authors = [
+  {name = "RF-Tar-Railt", email = "rf_tar_railt@qq.com"}
+]
+dependencies = []
+description = "Satori Protocol SDK for python, adapter for QQ"
+license = {text = "MIT"}
+readme = "README.md"
+requires-python = ">=3.10,<4.0"
+classifiers = [
+    "Typing :: Typed",
+    "Development Status :: 4 - Beta",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+homepage = "https://github.com/RF-Tar-Railt/satori-python"
+repository = "https://github.com/RF-Tar-Railt/satori-python"

satori_python_adapter_qq-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 RF-Tar-Railt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

satori_python_adapter_qq-0.1.0/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.1
+Name: satori-python-adapter-qq
+Version: 0.1.0
+Summary: Satori Protocol SDK for python, adapter for QQ
+Home-page: https://github.com/RF-Tar-Railt/satori-python
+Author-Email: RF-Tar-Railt <rf_tar_railt@qq.com>
+License: MIT
+Classifier: Typing :: Typed
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Project-URL: Homepage, https://github.com/RF-Tar-Railt/satori-python
+Project-URL: Repository, https://github.com/RF-Tar-Railt/satori-python
+Requires-Python: <4.0,>=3.10
+Requires-Dist: satori-python>=0.18.0
+Requires-Dist: crypography>=46.0.4
+Description-Content-Type: text/markdown
+
+# satori-python
+
+![latest release](https://img.shields.io/github/release/RF-Tar-Railt/satori-python)
+[![Licence](https://img.shields.io/github/license/RF-Tar-Railt/satori-python)](https://github.com/RF-Tar-Railt/satori-python/blob/main/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/satori-python)](https://pypi.org/project/satori-python)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/satori-python)](https://www.python.org/)
+
+基于 [Satori](https://satori.chat/zh-CN/) 协议的 Python 开发工具包
+
+## 协议介绍
+
+[Satori Protocol](https://satori.chat/zh-CN/)
+
+### 协议端
+
+目前提供了 `satori` 协议实现的有：
+
+- [Chronocat](https://chronocat.vercel.app)
+- [LLBot](https://www.llonebot.com/guide/introduction)
+- [nekobox](https://github.com/wyapx/nekobox)
+- Koishi （搭配 `@koishijs/plugin-server`）
+
+### 使用该 SDK 的框架
+
+- [`Entari`](https://github.com/ArcletProject/Entari)
+
+## 安装
+
+安装完整体：
+```shell
+pip install satori-python
+```
+
+只安装基础部分：
+```shell
+pip install satori-python-core
+```
+
+只安装客户端部分：
+```shell
+pip install satori-python-client
+```
+
+只安装服务端部分：
+```shell
+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          |
+| QQ         | `pip install satori-python-adapter-qq`       | satori.adapters.milky.main, satori.adapters.milky.websocket        |
+
+### 社区适配器
+
+| 适配器               | 安装                    | 路径           |
+|-------------------|-----------------------|--------------|
+| nekobox(Lagrange) | `pip install nekobox` | nekobox.main |
+
+## 使用
+
+客户端：
+
+```python
+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()
+```
+
+服务端：
+
+```python
+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()
+```
+
+## 文档
+
+请阅读 [仓库文档](./docs.md)
+
+## 示例
+
+- 客户端：[client.py](./example/client.py)
+- 服务端：[server.py](./example/server.py)
+  - 服务端(使用适配器)：[server_with_adapter.py](./example/server_with_adapter.py)
+- 客户端(webhook)：[client_webhook](./example/client_webhook.py)
+- 服务端(webhook)：[server_webhook](./example/server_webhook.py)
+- 适配器：[adapter.py](./example/adapter.py)
+
+## 架构
+
+```mermaid
+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
+```

satori_python_adapter_qq-0.1.0/README.md

@@ -0,0 +1,131 @@
+# satori-python
+
+![latest release](https://img.shields.io/github/release/RF-Tar-Railt/satori-python)
+[![Licence](https://img.shields.io/github/license/RF-Tar-Railt/satori-python)](https://github.com/RF-Tar-Railt/satori-python/blob/main/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/satori-python)](https://pypi.org/project/satori-python)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/satori-python)](https://www.python.org/)
+
+基于 [Satori](https://satori.chat/zh-CN/) 协议的 Python 开发工具包
+
+## 协议介绍
+
+[Satori Protocol](https://satori.chat/zh-CN/)
+
+### 协议端
+
+目前提供了 `satori` 协议实现的有：
+
+- [Chronocat](https://chronocat.vercel.app)
+- [LLBot](https://www.llonebot.com/guide/introduction)
+- [nekobox](https://github.com/wyapx/nekobox)
+- Koishi （搭配 `@koishijs/plugin-server`）
+
+### 使用该 SDK 的框架
+
+- [`Entari`](https://github.com/ArcletProject/Entari)
+
+## 安装
+
+安装完整体：
+```shell
+pip install satori-python
+```
+
+只安装基础部分：
+```shell
+pip install satori-python-core
+```
+
+只安装客户端部分：
+```shell
+pip install satori-python-client
+```
+
+只安装服务端部分：
+```shell
+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          |
+| QQ         | `pip install satori-python-adapter-qq`       | satori.adapters.milky.main, satori.adapters.milky.websocket        |
+
+### 社区适配器
+
+| 适配器               | 安装                    | 路径           |
+|-------------------|-----------------------|--------------|
+| nekobox(Lagrange) | `pip install nekobox` | nekobox.main |
+
+## 使用
+
+客户端：
+
+```python
+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()
+```
+
+服务端：
+
+```python
+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()
+```
+
+## 文档
+
+请阅读 [仓库文档](./docs.md)
+
+## 示例
+
+- 客户端：[client.py](./example/client.py)
+- 服务端：[server.py](./example/server.py)
+  - 服务端(使用适配器)：[server_with_adapter.py](./example/server_with_adapter.py)
+- 客户端(webhook)：[client_webhook](./example/client_webhook.py)
+- 服务端(webhook)：[server_webhook](./example/server_webhook.py)
+- 适配器：[adapter.py](./example/adapter.py)
+
+## 架构
+
+```mermaid
+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
+```

satori_python_adapter_qq-0.1.0/pyproject.toml

@@ -0,0 +1,119 @@
+[project]
+name = "satori-python-adapter-qq"
+version = "0.1.0"
+authors = [
+    { name = "RF-Tar-Railt", email = "rf_tar_railt@qq.com" },
+]
+dependencies = [
+    "satori-python >= 0.18.0",
+    "crypography>=46.0.4",
+]
+description = "Satori Protocol SDK for python, adapter for QQ"
+readme = "README.md"
+requires-python = ">=3.10,<4.0"
+classifiers = [
+    "Typing :: Typed",
+    "Development Status :: 4 - Beta",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+]
+
+[project.license]
+text = "MIT"
+
+[project.urls]
+homepage = "https://github.com/RF-Tar-Railt/satori-python"
+repository = "https://github.com/RF-Tar-Railt/satori-python"
+
+[build-system]
+requires = [
+    "mina-build<0.6,>=0.5.1",
+    "pdm-backend<2.4.0",
+]
+build-backend = "mina.backend"
+
+[dependency-groups]
+dev = [
+    "isort>=5.13.2",
+    "black>=24.4.0",
+    "ruff>=0.4.1",
+    "pre-commit>=3.7.0",
+    "fix-future-annotations>=0.5.0",
+    "mina-build<0.6,>=0.5.1",
+    "pdm-mina>=0.3.2",
+    "nonechat<0.7.0,>=0.6.0",
+    "uvicorn[standard]>=0.37.0",
+]
+
+[tool.pdm.build]
+includes = [
+    "src/satori/adapters/qq",
+    ".mina/adapter_qq.toml",
+]
+excludes = [
+    "src/satori/adapters/*",
+]
+
+[tool.pdm.scripts.format]
+composite = [
+    "isort ./src/ ./example/",
+    "black ./src/ ./example/",
+    "ruff check",
+]
+
+[tool.pdm.version]
+source = "file"
+path = "src/satori/__init__.py"
+
+[tool.black]
+line-length = 120
+include = "\\.pyi?$"
+extend-exclude = ""
+
+[tool.isort]
+profile = "black"
+line_length = 120
+skip_gitignore = true
+extra_standard_library = [
+    "typing_extensions",
+]
+
+[tool.ruff]
+line-length = 120
+target-version = "py310"
+exclude = [
+    "exam_qps.py",
+    "exam1.py",
+    "exam2.py",
+    "src/satori/_vendor/*",
+]
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "W",
+    "F",
+    "UP",
+    "C",
+    "T",
+    "Q",
+]
+ignore = [
+    "E402",
+    "F403",
+    "F405",
+    "C901",
+    "T201",
+]
+
+[tool.pyright]
+pythonPlatform = "All"
+pythonVersion = "3.10"
+typeCheckingMode = "basic"
+reportShadowedImports = false
+disableBytesTypePromotions = true