cyansdk 0.2.0

A Python SDK for QQ Bot.

---

简介

Cyan 是一个简单易用的 QQ 机器人 Python SDK，基于 Python 的类型注解和异步特性。

项目状态

项目目前处于测试阶段，这意味着 SDK 所提供的操作不稳定，不建议用于生产环境。

仓库

HuajiTech GitLab（主仓库）：https://gitlab.huajitech.net/huajitech/cyan

GitHub：https://github.com/huajitech/cyan

特性

• 异步操作：使用 httpx、websockets 异步框架及 Python 的异步特性
• 化繁为简：简化 API 繁琐的操作，使用户容易上手
• 类型注释：SDK 100% 使用类型注解，通过 Pyright 的严格检查，用户可使用支持类型检查的 IDE 减少 Bug 出现的可能性
• 支持扩展：SDK 开放与 API 交互的函数，用户可通过提供的函数与 API 交互，实现 SDK 未实现的功能

如何使用

安装

1. 通过 pip 安装 Cyan (release)：

   pip install cyansdk
   

2. 通过 pip 安装 Cyan (nightly)：https://gitlab.huajitech.net/huajitech/cyan/-/packages

文档

https://huajitech.proj.zone/cyan

示例

from cyan import Session, Ticket
from cyan.event import ChannelMessageReceivedEvent
from cyan.model import ChannelMessage

session = Session(
    "https://sandbox.api.sgroup.qq.com/",
    Ticket("{app_id}", "{token}")
)


@session.on(ChannelMessageReceivedEvent)
async def message_received(data: ChannelMessage):
    await data.reply("收到消息：\n", data)

session.run()

更多