Skip to main content

QQ robot webhook server using Python 3

Project description

ymbotpy

ymbotpy 是基于 机器人开放平台API https://bot.q.qq.com/wiki/develop/api/ 实现的机器人框架,目的提供一个易使用、开发效率高的开发框架,此版本为webhook版本,非Tencent官方SDK。

项目简介

本项目为 QQ 频道机器人提供了 Python SDK,支持qq-botpy所有方法,并封装了基础的 webhook 通信,具备签名校验以及垃圾信息过滤。

特性

  • 兼容 Python 3.7+
  • 简单、易用、快速集成,过滤垃圾消息以及消息鉴权
  • 可无缝替换websocket版本qq-botpy

安装

pip install ymbotpy

快速上手

import ymbotpy
from ymbotpy.message import DirectMessage, Message, GroupMessage, C2CMessage

class MyClient(ymbotpy.Client):
    async def on_at_message_create(self, message: Message):
        """频道内@"""
        await message.reply(content=f"机器人{self.robot.name}收到你的@消息了: {message.content}")

if __name__ == "__main__":
    BOT_APPID = 'botid'
    BOT_SECRET = 'secert'
    client = MyClient()
    client.run(appid=BOT_APPID,secret=BOT_SECRET,port=8080,system_log=True)

在开发平台应配置的回调地址为:example.com/qbot/webhook,您可以通过以下方式来修改回调URL

client.run(appid=BOT_APPID,secret=BOT_SECRET,port=8080,system_log=True,hook_route='/your_url')

配置SSL以直接实现域名直接访问

client.run(appid=BOT_APPID,secret=BOT_SECRET,port=443,system_log=True,
    ssl_keyfile='ssl/private.key',ssl_certfile='ssl/public.crt')

注意: 由于通信方式的变化, 不再需要在本地注册监听事件,只需要注册具体的事件代码即可,事件开关在平台控制

文档

有关此 SDK 更多用法,请查阅qq-botpy https://github.com/tencent-connect/botpy

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ymbotpy-1.0.0.dev0.tar.gz (39.1 kB view details)

Uploaded Source

File details

Details for the file ymbotpy-1.0.0.dev0.tar.gz.

File metadata

  • Download URL: ymbotpy-1.0.0.dev0.tar.gz
  • Upload date:
  • Size: 39.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for ymbotpy-1.0.0.dev0.tar.gz
Algorithm Hash digest
SHA256 8fba7ebba0c87cbf84eb417ec9223fc1f4e0b9a414a21fc2385db9483af7de97
MD5 1ae20e93c0eb69f764eb86f5cf06090d
BLAKE2b-256 c1ee66db7b5cc89ef90d380f9f825a8b6dd6f8a73ac3f1024f00d09c04765bac

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page