Skip to main content

A NoneBot2 plugin generates a picture which shows the status of current device

Project description

NoneBot-Plugin-PicStatus

✨ 运行状态图片版 for NoneBot2 ✨

license pypi python pypi download wakatime

📖 介绍

不多说,直接看图!

效果图

example

💿 安装

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

打开 nonebot2 项目的 bot.py 文件, 在其中写入

nonebot.load_plugin('nonebot_plugin_picstatus')
从 github 安装 在 nonebot2 项目的插件目录下, 打开命令行, 输入以下命令克隆此储存库
git clone https://github.com/lgc2333/nonebot-plugin-picstatus.git

打开 nonebot2 项目的 bot.py 文件, 在其中写入

nonebot.load_plugin('src.plugins.nonebot_plugin_picstatus')

⚙️ 配置

在 nonebot2 项目的.env文件中添加下表中的必填配置

配置项 类型 必填 默认值 说明
PS_ONLY_SU 布尔值(bool False 是否只能由SuperUsers触发指令
PS_NEED_AT 布尔值(bool False 触发指令是否需要@Bot
PS_USE_ENV_NICK 布尔值(bool False 使用.env.*中配置的NICKNAME作为图片上的 Bot 昵称
PS_IGNORE_PARTS 文本列表(List[str] [] 分区列表里忽略的盘符(挂载点)
使用正则表达式匹配
PS_IGNORE_BAD_PARTS 布尔值(bool False 忽略获取容量状态失败的磁盘分区
PS_IGNORE_DISK_IOS 文本列表(List[str] [] 磁盘 IO 统计列表中忽略的磁盘名
使用正则表达式匹配
PS_IGNORE_NETS 文本列表(List[str] ["^lo$", "^Loopback"] 网速列表中忽略的网络名称
使用正则表达式匹配
PS_IGNORE_NO_IO_DISK 布尔值(bool False 是否忽略 IO 都为 0B/s 的磁盘
PS_IGNORE_0B_NET 布尔值(bool False 是否忽略上下行都为 0B/s 的网卡
PS_MASK_COLOR 4 整数元组(Tuple[int, int, int, int] [255, 255, 255, 125] 背景图遮罩颜色
PS_BG_COLOR 4 整数元组(Tuple[int, int, int, int] [255, 255, 255, 150] 各状态矩形背景底色
PS_BLUR_RADIUS 整数(int 4 背景图高斯模糊半径
PS_FONT 文本(str 自定义字体路径
PS_CUSTOM_BG 文本列表(List[str] [] 自定义背景图 URL 列表
本地图请使用file:///文件路径
PS_FOOTER_SIZE 整数(int 22 底部脚注文字大小

🎉 使用

使用指令运行状态(或者状态 / zt / yxzt / status)来触发插件功能
可以在消息后面跟一张图片或者回复一张图片来自定义背景图,默认为随机背景图
更多自定义项参见 配置

📞 联系

QQ:3076823485
Telegram:@lgc2333
吹水群:1105946125
邮箱:lgc2333@126.com

💡 鸣谢

故梦 API

  • 随机背景图来源

💰 赞助

感谢大家的赞助!你们的赞助将是我继续创作的动力!

  • 爱发电

  • 赞助二维码(点击展开)

    讨饭

📝 更新日志

0.2.5

配置项更新详见 配置

  • 更新配置项 PS_FOOTER_SIZE

0.2.4

  • 支持自定义默认背景图
  • 一些配置项类型更改(不影响原先配置)

0.2.3

  • 尝试修复磁盘列表的潜在 bug

0.2.2

此版本在图片脚注中显示的版本还是0.2.1,抱歉,我大意了没有改版本号

  • 添加配置项PS_IGNORE_NO_IO_DISK用于忽略 IO 为 0B/s 的磁盘
  • 添加配置项PS_IGNORE_0B_NET用于忽略上下行都为 0B/s 的网卡
  • 添加触发指令zt yxzt status
  • 获取信息收发量兼容旧版 GoCQ ,即使获取失败也不会报错而显示未知
  • 将忽略 IO 统计磁盘名独立出一个配置项PS_IGNORE_DISK_IOS
  • 忽略 磁盘容量盘符/IO 统计磁盘名/网卡名称 改为匹配正则表达式
  • 配置项PS_IGNORE_NETS添加默认值["^lo$", "^Loopback"]
  • 修复空闲内存显示错误的问题

0.2.1

  • 尝试修复type object is not subscriptable报错

0.2.0

  • 新增磁盘 IO、网络 IO 状态显示
  • SWAP 大小为 0 时占用率将会显示未部署而不是0%
  • CPU 等占用下方灰色字排板更改
  • 获取失败的磁盘分区占用率修改为未知%
  • 图片下方脚注修改为居中文本,字号调小,优化显示的系统信息
  • 修改随机背景图 API 为故梦 API 随机二次元壁纸
  • 现在会分 QQ 记录 Bot 连接时间(不同的 QQ 连接同一个 NoneBot 显示的连接时间将不同)
  • 背景图增加遮罩,颜色可配置
  • 可以配置各模块的背景底色
  • 可以配置分区列表中忽略的盘符(挂载点)
  • 可以忽略获取容量状态失败的分区
  • 可以使用.env.*文件中配置的NICKNAME作为图片中的 Bot 昵称
  • 添加必须 @Bot 才能触发指令的配置
  • 其他小优化/更改

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_picstatus-0.2.5.tar.gz (16.1 MB view hashes)

Uploaded Source

Built Distribution

nonebot_plugin_picstatus-0.2.5-py3-none-any.whl (16.1 MB view hashes)

Uploaded Python 3

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