ErisPulse-OneBot12Adapter 4.0.1__tar.gz → 4.4.0__tar.gz

erispulse_onebot12adapter-4.4.0/ErisPulse_OneBot12Adapter.egg-info/PKG-INFO

@@ -0,0 +1,450 @@
+Metadata-Version: 2.4
+Name: ErisPulse-OneBot12Adapter
+Version: 4.4.0
+Summary: ErisPulse的OneBotV12协议适配模块，基线协议适配器
+Author-email: wsu2059q <wsu2059@qq.com>
+License: MIT License
+        
+        Copyright (c) 2025 WSu2059
+        
+        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.
+        
+Project-URL: homepage, https://github.com/ErisPulse/ErisPulse-OneBot12Adapter
+Keywords: erispulse,erispulse-adapter
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+<div align="center">
+
+<img src=".github/assets/ErisPulseLogo.png" width="180" alt="ErisPulse OneBot12Adapter" />
+
+# ErisPulse OneBot12Adapter
+
+**OneBot v12 baseline protocol adapter — multi-account, Server/Client dual mode.**
+
+A OneBot V12 baseline protocol adapter for the ErisPulse framework. It transparently passes through standard-format events, runs multiple accounts simultaneously, and supports both Server (passive) and Client (active) WebSocket modes.
+
+<p>
+  <a href="https://pypi.org/project/ErisPulse-OneBot12Adapter/"><img src="https://img.shields.io/pypi/v/ErisPulse-OneBot12Adapter?style=for-the-badge&logo=pypi&logoColor=white" alt="PyPI"></a>
+  <a href="https://pypi.org/project/ErisPulse-OneBot12Adapter/"><img src="https://img.shields.io/badge/Python-3.10+-FFD43B?style=for-the-badge&logo=python&logoColor=blue" alt="Python"></a>
+  <a href="./LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue?style=for-the-badge" alt="License"></a>
+  <a href="https://github.com/ErisPulse/ErisPulse-OneBot12Adapter"><img src="https://img.shields.io/github/stars/ErisPulse/ErisPulse-OneBot12Adapter?style=for-the-badge&logo=github&color=brightgreen" alt="Stars"></a>
+  <a href="https://pepy.tech/project/ErisPulse-OneBot12Adapter"><img src="https://img.shields.io/pepy/dt/ErisPulse-OneBot12Adapter?style=for-the-badge&color=blue" alt="Downloads"></a>
+  <a href="https://github.com/ErisPulse/ErisPulse"><img src="https://img.shields.io/badge/Powered_by-ErisPulse-FF6B9D?style=for-the-badge&logo=bookstack&logoColor=white" alt="ErisPulse"></a>
+</p>
+
+[English](#english) | [简体中文](#中文)
+
+</div>
+
+---
+
+<a id="english"></a>
+
+## English
+
+A OneBot V12 baseline protocol adapter for the [ErisPulse](https://github.com/ErisPulse/ErisPulse/) framework, supporting multi-account and Server/Client dual mode operation.
+
+### Installation
+
+```bash
+epsdk install OneBot12Adapter
+```
+
+### Configuration
+
+Add to `config/config.toml`:
+
+```toml
+[OneBotv12_Adapter.accounts.main]
+bot_id = "Bot ID"
+mode = "server"
+server_path = "/onebot12"
+server_token = ""
+enabled = true
+
+# Client mode example
+[OneBotv12_Adapter.accounts.backup]
+bot_id = "Another Bot ID"
+mode = "client"
+client_url = "ws://127.0.0.1:3002"
+client_token = ""
+enabled = true
+```
+
+#### Configuration Fields
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| `bot_id` | string | Yes | Bot ID, used for SDK routing |
+| `mode` | string | No | Run mode: `server` (passive) or `client` (active), default `server` |
+| `server_path` | string | No | Server mode WS path, default `/onebot12` |
+| `server_token` | string | No | Server mode authentication Token |
+| `client_url` | string | No | Client mode WS address, default `ws://127.0.0.1:3001` |
+| `client_token` | string | No | Client mode authentication Token |
+| `enabled` | bool | No | Whether to enable (default true) |
+| `platform` | string | No | Platform identifier, default `onebot12` |
+| `implementation` | string | No | Implementation identifier (e.g., `go-cqhttp`) |
+
+### Quick Start
+
+```python
+from ErisPulse import sdk
+from ErisPulse.Core.Event import command, message
+
+@command("hello")
+async def hello_handler(event):
+    await event.reply("Hello from OneBot12!")
+
+async def main():
+    await sdk.run(keep_running=True)
+
+if __name__ == "__main__":
+    import asyncio
+    asyncio.run(main())
+```
+
+### Sending Messages
+
+```python
+onebot12 = sdk.adapter.get("onebot12")
+
+# Text messages
+await onebot12.Send.To("user", "123456").Text("Hello!")
+await onebot12.Send.To("group", "789012").Text("Group message")
+
+# Media messages
+await onebot12.Send.To("user", "123456").Image("file_id_or_url")
+await onebot12.Send.To("user", "123456").Video("file_id_or_url")
+await onebot12.Send.To("user", "123456").Audio("file_id_or_url")
+
+# Send bytes
+with open("image.png", "rb") as f:
+    await onebot12.Send.To("user", "123456").Image(f.read())
+
+# Location
+await onebot12.Send.To("group", "789012").Location(39.9042, 116.4074, title="Beijing")
+```
+
+#### Chain Modifiers
+
+```python
+# @user
+await onebot12.Send.To("group", "789012").At("123456").Text("Hello!")
+
+# @everyone
+await onebot12.Send.To("group", "789012").AtAll().Text("Announcement!")
+
+# Reply to message
+await onebot12.Send.To("group", "789012").Reply("msg_id").Text("Reply content")
+
+# Combined usage
+await onebot12.Send.To("group", "789012").Reply("msg_id").At("123456").Text("Reply and @mention")
+```
+
+#### Sending via a Specific Account
+
+```python
+# Use Using to specify the account
+await onebot12.Send.Using("backup").To("user", "123456").Text("From backup account")
+```
+
+#### Message Operations
+
+```python
+# Recall
+await onebot12.Send.To("group", "789012").Recall("message_id")
+
+# Edit
+await onebot12.Send.To("group", "789012").Edit("message_id", "New content")
+
+# Raw OB12 message segments
+await onebot12.Send.To("group", "789012").Raw_ob12([
+    {"type": "text", "data": {"text": "Hello"}},
+    {"type": "image", "data": {"file_id": "xxx"}}
+])
+```
+
+### Run Modes
+
+#### Server Mode (default)
+
+Starts a WS server waiting for OneBot12 implementation clients to connect. Suitable for scenarios where multiple clients connect to the same server.
+
+#### Client Mode
+
+Actively connects to a OneBot12 implementation. Supports automatic reconnection (30-second interval).
+
+### Event Handling
+
+The OneBot12 adapter passes through standard-format events directly, with no conversion needed. Use the ErisPulse standard event handlers:
+
+```python
+from ErisPulse.Core.Event import message, notice, request, meta
+
+@message.on_message()
+async def handle_message(event):
+    text = event.get_text()
+    user_id = event.get_user_id()
+    group_id = event.get_group_id()
+    await event.reply(f"Received: {text}")
+
+@notice.on_group_increase()
+async def handle_member_increase(event):
+    group_id = event.get_group_id()
+    user_id = event.get_user_id()
+    await event.reply(f"Welcome {user_id} to the group!")
+
+@request.on_friend_request()
+async def handle_friend_request(event):
+    user_id = event.get_user_id()
+    comment = event.get_comment()
+```
+
+#### Event Extension Fields
+
+All events automatically have a `onebot12_raw_type` field added to preserve the original event type.
+
+### API Calls
+
+```python
+# Direct API call
+resp = await onebot12.call_api(
+    "get_user_info",
+    _account_id="main",
+    user_id="123456"
+)
+
+# Get self info
+info = await onebot12.call_api("get_self_info", _account_id="main")
+```
+
+#### Response Format
+
+```python
+# Success
+{"status": "ok", "retcode": 0, "data": {...}, "message_id": "xxx", "message": ""}
+
+# Failure
+{"status": "failed", "retcode": 10003, "data": None, "message_id": "", "message": "Error description"}
+```
+
+### Reference Links
+
+- [ErisPulse main repository](https://github.com/ErisPulse/ErisPulse/)
+- [OneBot V12 protocol documentation](https://12.onebot.dev/)
+
+---
+
+<a id="中文"></a>
+
+## 中文
+
+基于 [ErisPulse](https://github.com/ErisPulse/ErisPulse/) 框架的 OneBot V12 基线协议适配器，支持多账号、Server/Client 双模式运行。
+
+## 安装
+
+```bash
+epsdk install OneBot12Adapter
+```
+
+## 配置
+
+在 `config/config.toml` 中添加：
+
+```toml
+[OneBotv12_Adapter.accounts.main]
+bot_id = "机器人ID"
+mode = "server"
+server_path = "/onebot12"
+server_token = ""
+enabled = true
+
+# Client 模式示例
+[OneBotv12_Adapter.accounts.backup]
+bot_id = "另一个机器人ID"
+mode = "client"
+client_url = "ws://127.0.0.1:3002"
+client_token = ""
+enabled = true
+```
+
+### 配置字段
+
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| `bot_id` | string | 是 | 机器人ID，用于SDK路由 |
+| `mode` | string | 否 | 运行模式：`server`（被动）或 `client`（主动），默认 `server` |
+| `server_path` | string | 否 | Server 模式 WS 路径，默认 `/onebot12` |
+| `server_token` | string | 否 | Server 模式认证 Token |
+| `client_url` | string | 否 | Client 模式 WS 地址，默认 `ws://127.0.0.1:3001` |
+| `client_token` | string | 否 | Client 模式认证 Token |
+| `enabled` | bool | 否 | 是否启用（默认 true） |
+| `platform` | string | 否 | 平台标识，默认 `onebot12` |
+| `implementation` | string | 否 | 实现标识（如 `go-cqhttp`） |
+
+## 快速开始
+
+```python
+from ErisPulse import sdk
+from ErisPulse.Core.Event import command, message
+
+@command("hello")
+async def hello_handler(event):
+    await event.reply("Hello from OneBot12!")
+
+async def main():
+    await sdk.run(keep_running=True)
+
+if __name__ == "__main__":
+    import asyncio
+    asyncio.run(main())
+```
+
+## 消息发送
+
+```python
+onebot12 = sdk.adapter.get("onebot12")
+
+# 文本消息
+await onebot12.Send.To("user", "123456").Text("Hello!")
+await onebot12.Send.To("group", "789012").Text("群消息")
+
+# 媒体消息
+await onebot12.Send.To("user", "123456").Image("file_id_or_url")
+await onebot12.Send.To("user", "123456").Video("file_id_or_url")
+await onebot12.Send.To("user", "123456").Audio("file_id_or_url")
+
+# 发送 bytes
+with open("image.png", "rb") as f:
+    await onebot12.Send.To("user", "123456").Image(f.read())
+
+# 位置
+await onebot12.Send.To("group", "789012").Location(39.9042, 116.4074, title="北京")
+```
+
+### 链式修饰
+
+```python
+# @用户
+await onebot12.Send.To("group", "789012").At("123456").Text("你好！")
+
+# @全体
+await onebot12.Send.To("group", "789012").AtAll().Text("通知！")
+
+# 回复消息
+await onebot12.Send.To("group", "789012").Reply("msg_id").Text("回复内容")
+
+# 组合使用
+await onebot12.Send.To("group", "789012").Reply("msg_id").At("123456").Text("回复并@")
+```
+
+### 指定账户发送
+
+```python
+# 使用 Using 指定账户
+await onebot12.Send.Using("backup").To("user", "123456").Text("来自备用账户")
+```
+
+### 消息操作
+
+```python
+# 撤回
+await onebot12.Send.To("group", "789012").Recall("message_id")
+
+# 编辑
+await onebot12.Send.To("group", "789012").Edit("message_id", "新内容")
+
+# 原始 OB12 消息段
+await onebot12.Send.To("group", "789012").Raw_ob12([
+    {"type": "text", "data": {"text": "你好"}},
+    {"type": "image", "data": {"file_id": "xxx"}}
+])
+```
+
+## 运行模式
+
+### Server 模式（默认）
+
+启动 WS 服务器等待 OneBot12 实现端连接。适用于多客户端连接同一服务端的场景。
+
+### Client 模式
+
+主动连接 OneBot12 实现端。支持自动重连（间隔 30 秒）。
+
+## 事件处理
+
+OneBot12 适配器直接 pass-through 标准格式事件，无需转换。使用 ErisPulse 标准事件处理器：
+
+```python
+from ErisPulse.Core.Event import message, notice, request, meta
+
+@message.on_message()
+async def handle_message(event):
+    text = event.get_text()
+    user_id = event.get_user_id()
+    group_id = event.get_group_id()
+    await event.reply(f"收到: {text}")
+
+@notice.on_group_increase()
+async def handle_member_increase(event):
+    group_id = event.get_group_id()
+    user_id = event.get_user_id()
+    await event.reply(f"欢迎 {user_id} 加入群!")
+
+@request.on_friend_request()
+async def handle_friend_request(event):
+    user_id = event.get_user_id()
+    comment = event.get_comment()
+```
+
+### 事件扩展字段
+
+所有事件自动添加 `onebot12_raw_type` 字段保留原始事件类型。
+
+## API 调用
+
+```python
+# 直接 API 调用
+resp = await onebot12.call_api(
+    "get_user_info",
+    _account_id="main",
+    user_id="123456"
+)
+
+# 获取自身信息
+info = await onebot12.call_api("get_self_info", _account_id="main")
+```
+
+### 响应格式
+
+```python
+# 成功
+{"status": "ok", "retcode": 0, "data": {...}, "message_id": "xxx", "message": ""}
+
+# 失败
+{"status": "failed", "retcode": 10003, "data": None, "message_id": "", "message": "错误描述"}
+```
+
+## 参考链接
+
+- [ErisPulse 主库](https://github.com/ErisPulse/ErisPulse/)
+- [OneBot V12 协议文档](https://12.onebot.dev/)

{erispulse_onebot12adapter-4.0.1 → erispulse_onebot12adapter-4.4.0}/ErisPulse_OneBot12Adapter.egg-info/SOURCES.txt

@@ -7,4 +7,5 @@ ErisPulse_OneBot12Adapter.egg-info/dependency_links.txt
 ErisPulse_OneBot12Adapter.egg-info/entry_points.txt
 ErisPulse_OneBot12Adapter.egg-info/top_level.txt
 OneBot12Adapter/Core.py
-OneBot12Adapter/__init__.py
+OneBot12Adapter/__init__.py
+OneBot12Adapter/i18n.py