Skip to main content

bot断连时的通知插件

Project description

NoneBotPluginLogo

NoneBotPluginText

nonebot-plugin-disconnect-notice

✨ bot断连时的通知插件 ✨

license pypi python

📖 介绍

  • 可以在bot断开与nonebot的连接时向主人发送例如邮件的通知,用来通知主人bot可能被风控掉线
  • 目前支持全部适配器协议,通知方式支持邮件通知
  • 如果有其他通知方式的需求,欢迎提issus或pr

断连事件是通过判断nb与bot端的ws连接状态来实现的,当主动停止nonebot框架时,会先断开ws连接,随后再退出,这意味着主动停止nonebot框架时,也会收到插件发送的离线通知消息,这个无法避免,属于正常情况

💿 安装

使用 nb-cli 安装 在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
nb plugin install nonebot-plugin-disconnect-notice
使用包管理器安装 在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令
pdm
pdm add nonebot-plugin-disconnect-notice
poetry
poetry add nonebot-plugin-disconnect-notice

⚙️ 配置

运行插件前,需要在 nonebot2 项目的.env.prod文件中添加下表中的代理地址配置项

配置项 必填 值类型 默认值 说明
disconnect_notice_smtp_user str "" 邮箱账号,如 114514@yeah.net
disconnect_notice_smtp_password str "" 邮箱密码,如 114514
disconnect_notice_smtp_server str "" 邮箱服务器地址,如 smtp.yeah.net
disconnect_notice_smtp_port int 465 邮箱端口号,ssl模式时为465
disconnect_notice_notice_email str "" 收件人邮箱,填写自己邮箱即可
disconnect_notice_dev_mode bool False 开发者模式,该模式下bot断开连接不会触发通知消息,避免本地测试插件时不断重载而导致的大量掉线通知
示例配置
# disconnect_notice示例配置
disconnect_notice_smtp_user = "114514@yeah.net" #邮箱账号
disconnect_notice_smtp_password = "114514" #邮箱密码
disconnect_notice_smtp_server = "smtp.yeah.net" #邮箱服务器地址
disconnect_notice_smtp_port = 465 #邮箱端口号
disconnect_notice_notice_email = "114514@qq.com" #收件人邮箱

🎉 使用

指令表

指令 权限 需要@ 范围 说明
断连通知测试 主人 私聊/群聊 主动触发掉线通知测试,用来测试通知是否正常可用

效果图

邮件通知

mail.png

✨喜欢的话就点个star✨吧,球球了QAQ

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

nonebot_plugin_disconnect_notice-0.1.3.tar.gz (5.4 kB view hashes)

Uploaded Source

Built Distribution

Supported by

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