Skip to content
This repository was archived by the owner on Aug 15, 2024. It is now read-only.
/ CAI Public archive

🤖 又一个 QQ 协议支持库,使用 Python 编写 Yet Another Bot Framework for Tencent QQ Written in Python

License

Notifications You must be signed in to change notification settings

wyapx/CAI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

eb9c320 · Aug 15, 2024
Jun 13, 2023
Sep 12, 2023
Dec 8, 2021
Mar 27, 2023
Jan 29, 2021
May 28, 2021
Apr 7, 2021
Jan 26, 2021
Aug 15, 2024
Sep 12, 2023
Jun 13, 2023

Repository files navigation

过期协议,不再继续更新

CAI

✨ Yet Another Bot Framework for Tencent QQ Written in Python ✨

license python QQ Chat


声明

一切开发旨在学习,请勿用于非法用途

  • CAI 是完全免费且开放源代码的软件,仅供学习和娱乐用途使用
  • CAI 不会通过任何方式强制收取费用,或对使用者提出物质条件

许可证

CAI 采用 AGPLv3 协议开源,不鼓励、不支持一切商业使用。


特色

  • 简单易用的 API,支持多账号

  • 极少的额外依赖

    完整的 Type Hints(pep-0484)
    • Packet Query 支持 Variadic Generics

      from cai.utils.binary import Packet
      packet = Packet(bytes.fromhex("01000233000000"))
      packet.start().int8().uint16().bytes(4).execute()
      # return type: INT8, UINT16, BYTES
    • 便携的 JceStruct 定义 (使用方法参考 JceStruct)

      from typing import Optional
      from jce import JceStruct, JceField, types
      
      class CustomStruct(JceStruct):
          int32_field: types.INT32 = JceField(jce_id=0)
          optional_field: Optional[types.DOUBLE] = JceField(None, jce_id=1)
          nested_field: OtherStruct = JceField(jce_id=2)

功能

CAI 仅作为底层协议库使用,将协议封装为 API。

CAI 不会支持涉及 金钱主动邀请获取凭证 等敏感操作的协议。

已支持的协议列表:

登录

cai.api.login API Reference

  • 账号密码登录
  • 设备锁验证
  • 图片验证码提交
  • 短信验证码提交
  • 扫码登录
  • 短信验证码

客户端

cai.api.client API Reference

  • 设置在线状态
  • 上传图片/音频/视频/转发消息(用于发送聊天信息)
  • 获取音频下载链接(get_voice_download_url)

好友

cai.api.friend API Reference

  • 获取好友列表
  • 获取好友信息
  • 获取好友分组列表
  • 获取好友分组信息
  • 撤回消息
  • 发送文本信息(send_friend_msg)

群组

cai.api.group API Reference

  • 获取群列表
  • 获取群信息
  • 获取群成员列表
  • 发送群消息(send_group_msg)
  • 发送戳一戳(send_nudge)
  • 设置群管理(set_group_admin)
  • 禁言群员(mute_member)
  • 撤回消息(recall_group_msg)
  • 漫游消息(get_group_msg)

事件

cai.api.flow API Reference

通过注册事件监听回调,在事件发生时执行指定操作。事件类型可通过 cai.client.events 模块导入。

使用

快速安装

从 pypi 安装(推荐):

pip install cai-bot

从 git 安装(最新版,可能存在问题):

pip install git+https://github.com/wyapx/CAI@dev

二次开发

暂无文档,请参考 examples 中的源代码进行开发
注意:这需要你有 一定 的源代码阅读能力

分支信息

本仓库为 github.com/cscs181/CAI 的一个二次开发项目,遵循原有的开发许可证同时,不会修改原有文件内的版权信息
最后感谢 yanyongyu 开源的源码

About

🤖 又一个 QQ 协议支持库,使用 Python 编写 Yet Another Bot Framework for Tencent QQ Written in Python

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages