Metadata-Version: 2.3
Name: nonebot-plugin-error-show
Version: 0.1.0
Summary: nonebot的报错提示插件
Author: zifox666
Author-email: zifox666 <zifox666@gmail.com>
Requires-Dist: nonebot2>=2.4.2,<3.0.0
Requires-Dist: nonebot-plugin-localstore>=0.7.4,<1.0.0
Requires-Dist: nonebot-plugin-alconna>=0.59.3,<1.0.0
Requires-Dist: nonebot-plugin-htmlrender>=0.6.6
Requires-Dist: qrcode[pil]>=8.2
Requires-Python: >=3.10
Project-URL: Repository, https://github.com/zifox666/nonebot-plugin-error-show
Description-Content-Type: text/markdown

<div align="center">
    <a href="https://v2.nonebot.dev/store">
    <img src="https://raw.githubusercontent.com/fllesser/nonebot-plugin-template/refs/heads/resource/.docs/NoneBotPlugin.svg" width="310" alt="logo"></a>

## ✨ 错误可视化插件 ✨

<a href="./LICENSE">
    <img src="https://img.shields.io/github/license/zifox666/nonebot-plugin-error-show.svg" alt="license">
</a>
<a href="https://pypi.python.org/pypi/nonebot-plugin-error-show">
    <img src="https://img.shields.io/pypi/v/nonebot-plugin-error-show.svg" alt="pypi">
</a>
<img src="https://img.shields.io/badge/python-3.10+-blue.svg" alt="python">
<a href="https://github.com/astral-sh/uv">
    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json" alt="uv">
</a>
</div>

## 📖 介绍

非侵入式的错误可视化插件, 可以将代码中的错误以图片的形式发送到聊天窗口, 方便调试和排查问题。

## 💿 安装

<details open>
<summary>使用 nb-cli 安装</summary>
在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装

    nb plugin install nonebot-plugin-error-show --upgrade
使用 **pypi** 源安装

    nb plugin install nonebot-plugin-error-show --upgrade -i "https://pypi.org/simple"
使用**清华源**安装

    nb plugin install nonebot-plugin-error-show --upgrade -i "https://pypi.tuna.tsinghua.edu.cn/simple"


</details>

<details>
<summary>使用包管理器安装</summary>
在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令

<details open>
<summary>uv</summary>

    uv add nonebot-plugin-error-show
安装仓库 master 分支

    uv add git+https://github.com/zifox666/nonebot-plugin-error-show@master
</details>

<details>
<summary>pdm</summary>

    pdm add nonebot-plugin-error-show
安装仓库 master 分支

    pdm add git+https://github.com/zifox666/nonebot-plugin-error-show@master
</details>
<details>
<summary>poetry</summary>

    poetry add nonebot-plugin-error-show
安装仓库 master 分支

    poetry add git+https://github.com/zifox666/nonebot-plugin-error-show@master
</details>

打开 nonebot2 项目根目录下的 `pyproject.toml` 文件, 在 `[tool.nonebot]` 部分追加写入

    plugins = ["nonebot_plugin_error_show"]

</details>

## ⚙️ 配置

在 nonebot2 项目的`.env`文件中添加下表中的必填配置，将在错误信息最下面显示

|       配置项        | 必填 | 默认值 |     说明     |
|:----------------:|:--:| :----: |:----------:|
|    E_BOT_LINK    | 否  |   无   | 加BOT好友的链接  |
| E_BOT_GROUP_LINK | 否  |   无   | 加BOT服务群的链接 |
|     E_BOT_ID     | 否  |   无   |   BOT ID   |
|  E_BOT_GROUP_ID  | 否  |   无   |  BOT服务群ID  |
|     NICKNAME     | 否  |   无   |   BOT名称    |

## 🎉 使用
### 指令表
| 指令  | 权限  | 需要@ | 范围  |   说明   |
| :---: | :---: | :---: | :---: | :------: |
| 指令1 | 主人  |  否   | 私聊  | 指令说明 |
| 指令2 | 群员  |  是   | 群聊  | 指令说明 |

### 🎨 效果图
如果有效果图的话
