mecat-sdk

MeChat 开放世界即时通讯服务 Python SDK。同步阻塞风格，基于 requests + python-socketio， 覆盖全部 REST 端点与 Socket.IO 实时事件。

• Python ≥ 3.9
• 双通道：REST（一次性业务）+ WebSocket（实时推送）
• 事件回调用 @client.on("event") 装饰器注册

安装

pip install mecat-sdk
# 本地开发
pip install -e .

快速上手

from mecat import MecatClient

with MecatClient("http://localhost:3000") as c:
    # 注册并上线
    c.register_account("alice", "pass1234", nickname="Alice")
    c.connect_socket()

    # 也可以在注册前直接游客进入
    # c.quick_join(nickname="游客一号")

    # 订阅事件
    @c.on("new_message")
    def on_msg(data):
        print(f"{data['author']}: {data['content']}")

    c.send_message("大家好")

REST 接口

Socket 事件

输入（客户端→服务端）

管理员事件（16 个，需要 isAdmin / isSuperAdmin）

admin_delete_message admin_mute_user admin_unmute_user admin_broadcast admin_kick_user admin_kick_guests admin_ban_user admin_unban_user admin_get_user_info admin_clear_messages admin_cleanup admin_update_user admin_set_admin admin_unset_admin admin_get_lists admin_get_all_users

输出（服务端→客户端）

通过 @client.on("event_name") 订阅。常用：registered new_message private_message friend_request friend_accepted user_joined user_left user_moved kicked banned admin_result …

算法

mecat.algorithms 提供与服务端一致的实现： hash_password generate_id generate_session_token get_random_name get_random_color。

测试

python -m pytest tests/ -v

tests/test_integration.py 会自动拉起本机 X:\Project\Local\mecat 服务端做联调； 可通过环境变量 MECAT_SERVER_DIR 指向其他路径。若未安装 Node.js，联调测试会自动 skip。