imbot-sdk-python 0.1.0__tar.gz

imbot_sdk_python-0.1.0/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/), and the project adheres to
+[Semantic Versioning](https://semver.org/).
+
+## [0.1.0] - 2026-06-25
+
+### Added
+
+- Initial release of `imbot-sdk-python`.
+- Connection management: `connect` / `reconnect` / `disconnect` / `logout`,
+  heartbeat keep-alive, and automatic reconnect with backoff.
+- Message send/receive for private, group, chatroom and public-channel
+  conversations, with high-level listeners and raw protobuf callbacks.
+- Message management: history query, recall, modify, mark-read, search and
+  top-message APIs.
+- Conversation management: list, unread count, top, mute and tags.
+- User / friend / group info and online-status subscription.
+- Chatroom join/quit, messaging and attribute sync.
+- RTC room create / join / query / quit / invite.
+- File credential query.
+- Built-in message content models (text, image, file, video, voice, stream
+  text, recall info, merge, thumbnail-packed image, snapshot-packed video) with
+  an `UnknownMessage` fallback.
+
+[0.1.0]: https://github.com/juggleim/imbot-sdk-python/releases/tag/v0.1.0

imbot_sdk_python-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

imbot_sdk_python-0.1.0/MANIFEST.in

@@ -0,0 +1,17 @@
+include README.md
+include LICENSE
+include requirements.txt
+include CHANGELOG.md
+include imbot_sdk/py.typed
+
+# Source .proto definitions (for regenerating the protobuf modules)
+recursive-include proto *.proto *.sh
+
+# Docs and runnable examples
+recursive-include docs *.md
+recursive-include examples *.py *.sh
+include examples/.env.example
+
+# Keep build artifacts out of the sdist
+global-exclude __pycache__/*
+global-exclude *.py[cod]

imbot_sdk_python-0.1.0/PKG-INFO

@@ -0,0 +1,296 @@
+Metadata-Version: 2.4
+Name: imbot-sdk-python
+Version: 0.1.0
+Summary: JuggleIM Python Bot SDK — WebSocket long-connection IM client for bots and server-side agents
+Author-email: Tyler <tyler@juggle.im>
+Maintainer-email: Tyler <tyler@juggle.im>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/juggleim/imbot-sdk-python
+Project-URL: Repository, https://github.com/juggleim/imbot-sdk-python
+Project-URL: Issues, https://github.com/juggleim/imbot-sdk-python/issues
+Project-URL: Documentation, https://github.com/juggleim/imbot-sdk-python#readme
+Keywords: juggleim,im,instant-messaging,chat,bot,websocket,sdk
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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: Programming Language :: Python :: 3.13
+Classifier: Topic :: Communications :: Chat
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: protobuf>=5.0
+Requires-Dist: websocket-client>=1.6
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# imbot-sdk-python
+
+[![PyPI version](https://img.shields.io/pypi/v/imbot-sdk-python.svg)](https://pypi.org/project/imbot-sdk-python/)
+[![Python versions](https://img.shields.io/pypi/pyversions/imbot-sdk-python.svg)](https://pypi.org/project/imbot-sdk-python/)
+[![License](https://img.shields.io/pypi/l/imbot-sdk-python.svg)](https://github.com/juggleim/imbot-sdk-python/blob/main/LICENSE)
+
+`imbot-sdk-python` 是 JuggleIM 的 Python SDK，基于 WebSocket 与 IM 服务建立长连接，适合 Bot、服务端消息代理或需要主动收发消息的 Python 程序。覆盖连接管理、消息收发、会话查询、历史消息、聊天室、用户状态、RTC 房间和文件凭证查询等常用能力。
+
+- 源码：<https://github.com/juggleim/imbot-sdk-python>
+- 包名：`imbot-sdk-python`；导入名：`import imbot_sdk`
+
+## 安装
+
+```bash
+pip install imbot-sdk-python
+```
+
+依赖（`protobuf>=5.0`、`websocket-client>=1.6`）会自动安装。Python 3.8+。
+
+从源码安装：
+
+```bash
+git clone https://github.com/juggleim/imbot-sdk-python.git
+cd imbot-sdk-python
+pip install .
+```
+
+## 测试环境
+
+| 项目 | 值 |
+| --- | --- |
+| Server API | `http://127.0.0.1` |
+| WebSocket | `wss://127.0.0.1` |
+| AppKey | `AppKey` |
+
+> Token 由你的 JuggleIM 应用服务端 / 控制台用 AppKey + AppSecret 通过 Server API 颁发。SDK 本身只负责建立长连接与收发消息。
+
+## 能力概览
+
+- 连接管理：`connect`、`disconnect`、`logout`、心跳保活、断线自动重连
+- 消息收发：单聊、群聊、聊天室、公共频道消息发送与接收
+- 消息管理：历史消息查询、撤回、修改、已读标记、搜索、置顶消息
+- 会话管理：会话列表、未读数、置顶、免打扰、标签
+- 用户与群信息：用户资料、好友资料、群信息、在线状态订阅
+- 聊天室：加入/退出聊天室、聊天室消息、聊天室属性同步
+- RTC：创建/加入/查询/退出 RTC 房间
+- 文件：文件凭证查询 `get_file_cred`
+
+## 快速说明
+
+### 1. 创建客户端
+
+```python
+from imbot_sdk import ImBotClient
+
+client = ImBotClient("wss://127.0.0.1", "your-appkey")
+```
+
+说明：
+
+- `address` 传基础地址即可，SDK 会自动拼接为 `ws://host/imbot` 或 `wss://host/imbot`
+- `client.platform` 默认是 `"Bot"`
+- `client.auto_reconnect` 默认是 `True`
+
+### 2. 建立连接
+
+```python
+code, ack = client.connect("your-token")
+```
+
+说明：
+
+- 连接成功时 `code == ClientErrorCode.SUCCESS`
+- 成功后 `ack.userId` 会写入 `client.user_id`
+- `connect` 只能在断开状态下调用；重复连接会返回 `ClientErrorCode.CONNECT_EXISTED`
+- 主动调用 `disconnect()` 或 `logout()` 后，不会继续自动重连
+
+### 3. 接收消息的两种方式
+
+推荐优先使用高层监听（拿到的是已经解码后的 `Message`）：
+
+```python
+from imbot_sdk import MessageListener, messages
+
+class MyListener(MessageListener):
+    def on_message_receive(self, msg):
+        if isinstance(msg.msg_content, messages.TextMessage):
+            print("text:", msg.msg_content.content)
+
+client.add_message_listener(MyListener())
+```
+
+如果你想拿到底层 protobuf 数据：
+
+```python
+client.on_message_callback = lambda down_msg: print(down_msg)
+client.on_stream_msg_callback = lambda stream_msg: print(stream_msg)
+```
+
+### 4. 发送消息
+
+```python
+from imbot_sdk import Conversation, messages
+from imbot_sdk.pb import appmessages_pb2 as pb
+
+text = messages.TextMessage("hello from imbot-sdk-python")
+up = client.build_up_msg(text, client_uid="bot-1")
+
+conv = Conversation(conversation_type=pb.Private, conversation="target-user-id")
+code, ack = client.send_message(conv, up)
+# ack.msgId / ack.msgSeqNo 为服务端确认结果
+```
+
+`build_up_msg` 会把内容模型编码进 `UpMsg.msgType / msgContent / flags`；你也可以直接构造 `pb.UpMsg`。
+
+## 完整示例：连接、监听、回声
+
+```python
+import time
+from imbot_sdk import ImBotClient, Conversation, MessageListener, ClientErrorCode, messages
+from imbot_sdk.pb import appmessages_pb2 as pb
+
+class Echo(MessageListener):
+    def __init__(self, client):
+        self.client = client
+    def on_message_receive(self, msg):
+        c = msg.msg_content
+        if isinstance(c, messages.TextMessage) and msg.sender_id != self.client.user_id:
+            up = self.client.build_up_msg(messages.TextMessage("echo: " + c.content),
+                                          client_uid="echo-%d" % time.time_ns())
+            self.client.send_message(msg.conversation, up)
+
+client = ImBotClient("wss://127.0.0.1", "AppKey")
+client.add_message_listener(Echo(client))
+
+code, ack = client.connect("your-token")
+assert code == ClientErrorCode.SUCCESS
+print("connected:", ack.userId)
+
+# 主动给某用户发一条单聊
+up = client.build_up_msg(messages.TextMessage("hi"), client_uid="greet-1")
+client.send_message(Conversation(conversation_type=pb.Private, conversation="target-user-id"), up)
+
+try:
+    while True:
+        time.sleep(1)
+except KeyboardInterrupt:
+    client.disconnect()
+```
+
+可运行的版本见 [`examples/echo_bot.py`](examples/echo_bot.py)。推荐用 `.env` + 启动脚本：
+
+```bash
+cp examples/.env.example examples/.env
+# 编辑 examples/.env，至少填入 IMBOT_TOKEN（可选 IMBOT_TARGET）
+bash examples/run.sh
+```
+
+`run.sh` 会自动加载 `examples/.env` 并启动 echo bot，多余参数会透传给脚本（如
+`bash examples/run.sh --target some-user-id`）。也可以不用脚本，直接传参或导出环境变量：
+
+```bash
+python examples/echo_bot.py --token <your-token> --target <target-user-id>
+```
+
+配置项（环境变量 / `.env`）：
+
+| 变量 | 说明 | 必填 |
+| --- | --- | --- |
+| `IMBOT_TOKEN` | 用户 Token | 是 |
+| `IMBOT_TARGET` | 启动时打招呼的目标用户 ID | 否 |
+| `IMBOT_ADDRESS` | WebSocket 基础地址 | 否 |
+| `IMBOT_APPKEY` | 应用 AppKey | 否 |
+
+补充说明：
+
+- 单聊发送使用 `pb.Private`，群聊使用 `pb.Group`，聊天室使用 `pb.Chatroom`，公共频道使用 `pb.PublicChannel`
+- 聊天室消息也可以直接 `client.send_chatroom_msg(chatroom_id, up_msg)`
+- 接收到的 `msg.msg_content` 已按消息类型解码，可直接 `isinstance` 判断
+
+## 消息类型
+
+内置的消息内容模型位于 `imbot_sdk.messages`：
+
+| 类型 | 标识 | 类 |
+| --- | --- | --- |
+| 文本 | `jg:text` | `TextMessage` |
+| 图片 | `jg:img` | `ImageMessage` |
+| 文件 | `jg:file` | `FileMessage` |
+| 视频 | `jg:video` | `VideoMessage` |
+| 语音 | `jg:voice` | `VoiceMessage` |
+| 流式文本 | `jg:streamtext` | `StreamTextMessage` |
+| 撤回通知 | `jg:recallinfo` | `RecallInfoMessage` |
+| 合并消息 | `jg:merge` | `MergeMessage` |
+| 缩略图打包图片 | `jg:tpimg` | `ThumbnailPackedImageMessage` |
+| 快照打包视频 | `jg:spvideo` | `SnapshotPackedVideoMessage` |
+
+收到未内置支持的消息类型时，SDK 会回落为 `messages.UnknownMessage`。这些模型的 JSON 编解码字段保持稳定，因此消息可与其它 JuggleIM 客户端互通。
+
+## 常用 API
+
+> 完整方法清单见 [`docs/API.md`](docs/API.md)。命名采用 Python 风格（snake_case）。
+
+### 连接与状态
+
+`connect(token)`、`reconnect()`、`disconnect()`、`logout()`、`ping()`、`add_connection_status_change_listener(listener)`
+
+### 消息
+
+`send_message(conversation, up_msg)`、`qry_history_msgs(req)`、`recall_msg(req)`、`modify_msg(req)`、`mark_read_msg(req)`、`msg_search(req)`、`msg_global_search(req)`、`set_top_msg(req)`、`del_top_msg(req)`
+
+### 会话
+
+`get_conversation(req)`、`get_conversations(req)`、`sync_conversations(req)`、`clear_unread_count(req)`、`set_conversation_top(req)`、`set_mute(req)`、`delete_conversations(req)`
+
+### 用户、群组、状态
+
+`fetch_user_info(user_id)`、`fetch_group_info(group_id)`、`fetch_friend_info(friend_user_id)`、`get_user_status(req)`、`subscribe_user_status(req)`、`unsubscribe_user_status(req)`
+
+### 聊天室
+
+`join_chatroom(chatroom_id)`、`quit_chatroom(chatroom_id)`、`send_chatroom_msg(chatroom_id, up_msg)`、`set_attributes(chatroom_id, attributes)`、`remove_attributes(chatroom_id, keys)`
+
+### RTC
+
+`create_rtc_room(req)`、`join_rtc_room(req)`、`qry_rtc_room(room_id)`、`quit_rtc_room(room_id)`、`rtc_invite(req)`
+
+### 文件
+
+`get_file_cred(req)`
+
+> 当前 SDK 提供文件凭证查询能力，文件上传/下载流程需由业务侧结合存储服务自行处理。
+
+## 使用注意事项
+
+- `publish` 和 `query` 都要求当前连接状态为 `CONNECTED`，否则返回 `ClientErrorCode.CONNECT_CLOSED`
+- 发送和查询默认等待 10 秒 ACK，超时分别返回 `ClientErrorCode.SEND_TIMEOUT`、`ClientErrorCode.QUERY_TIMEOUT`
+- SDK 内部会自动处理心跳；连续超过两个心跳周期（约 20 秒）未收到下行数据，会断开并尝试自动重连
+- 消息监听回调运行在内部线程上，请避免长时间阻塞操作，必要时投递到工作队列
+- 图片、文件、语音、视频等消息体只负责内容编解码，不负责上传文件本身
+
+## 重新生成 protobuf
+
+`.proto` 源文件位于 [`proto/`](proto/)。修改后重新生成：
+
+```bash
+bash proto/gen.sh
+```
+
+## 模块结构
+
+| 模块 | 说明 |
+| --- | --- |
+| `imbot_sdk.ImBotClient` | 客户端主入口 |
+| `imbot_sdk.ClientErrorCode` / `ConnectState` | 错误码与连接状态 |
+| `imbot_sdk.models` | 领域模型（`Conversation` / `Message` / `UserInfo` …）|
+| `imbot_sdk.messages` | 消息内容模型 |
+| `imbot_sdk.pb` | protobuf 类型（`appmessages_pb2` / `connect_pb2` / `chatroom_pb2` / `rtcroom_pb2`）|
+
+## 许可证
+
+[LICENSE](LICENSE)