<!-- markdownlint-disable MD033 MD036 MD041 -->
<p align="center">
<a href="https://v2.nonebot.dev/"><img src="https://v2.nonebot.dev/logo.png" width="200" height="200" alt="nonebot"></a>
</p>
<div align="center">
# NoneBot Plugin TreeHelp
_✨ NoneBot 树形帮助插件 ✨_
</div>
<p align="center">
<a href="https://raw.githubusercontent.com/he0119/nonebot-plugin-treehelp/main/LICENSE">
<img src="https://img.shields.io/github/license/he0119/nonebot-plugin-treehelp.svg" alt="license">
</a>
<a href="https://pypi.python.org/pypi/nonebot-plugin-treehelp">
<img src="https://img.shields.io/pypi/v/nonebot-plugin-treehelp.svg" alt="pypi">
</a>
<img src="https://img.shields.io/badge/python-3.8+-blue.svg" alt="python">
<a href="https://codecov.io/gh/he0119/nonebot-plugin-treehelp">
<img src="https://codecov.io/gh/he0119/nonebot-plugin-treehelp/branch/main/graph/badge.svg?token=jd5ufc1alv"/>
</a>
<a href="https://jq.qq.com/?_wv=1027&k=7zQUpiGp">
<img src="https://img.shields.io/badge/QQ%E7%BE%A4-730374631-orange?style=flat-square" alt="QQ Chat Group">
</a>
</p>
## 简介
使用插件元数据获取插件信息，并通过插件与子插件的组织形式，来区分插件的多种功能。
树形帮助插件，最重要的功能当然是显示插件树！
发送 `/help --tree`，你将获得如下帮助：
```text
插件：
帮助 # 获取插件帮助信息
测试 # 一个测试插件
├── 复杂功能 # 测试插件复杂子插件
│ └── 二级功能 # 测试插件二级插件
└── 简单功能 # 测试插件简单子插件
```
## 使用方式
加载插件后发送 `/help help` 或 `/help --help` 获取具体用法。
## 插件适配
插件与子插件写法可参考 [示例插件](./tests/plugins/tree/)。
### 声明适配器
通过设置 adapters 属性来指定支持的适配器。如果不设置或留空则默认支持全部适配器。如果插件不支持该适配器，则不会在帮助列表上显示。
```python
__plugin_meta__ = PluginMetadata(
name="OneBot",
description="测试 OneBot 适配器",
usage="/onebot",
type="application",
supported_adapters={"~onebot.v11", "~onebot.v12"},
)
```
## 配置项
配置方式：直接在 `NoneBot` 全局配置文件中添加以下配置项即可。
### treehelp_ignored_plugins
- 类型: `list[str]`
- 默认: `[]`
- 说明: 需要忽略的插件名称列表
## 计划
- [ ] 支持输出插件版本
- [x] 支持输出插件树
- [ ] 支持输出插件内的命令名称
Raw data
{
"_id": null,
"home_page": "https://github.com/he0119/nonebot-plugin-treehelp",
"name": "nonebot-plugin-treehelp",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "hemengyang",
"author_email": "hmy0119@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0a/60/2411d42a436b258a80275d0696007f2748074d8888195cb4eefe34bfc391/nonebot_plugin_treehelp-0.4.1.tar.gz",
"platform": null,
"description": "<!-- markdownlint-disable MD033 MD036 MD041 -->\n\n<p align=\"center\">\n <a href=\"https://v2.nonebot.dev/\"><img src=\"https://v2.nonebot.dev/logo.png\" width=\"200\" height=\"200\" alt=\"nonebot\"></a>\n</p>\n\n<div align=\"center\">\n\n# NoneBot Plugin TreeHelp\n\n_\u2728 NoneBot \u6811\u5f62\u5e2e\u52a9\u63d2\u4ef6 \u2728_\n\n</div>\n\n<p align=\"center\">\n <a href=\"https://raw.githubusercontent.com/he0119/nonebot-plugin-treehelp/main/LICENSE\">\n <img src=\"https://img.shields.io/github/license/he0119/nonebot-plugin-treehelp.svg\" alt=\"license\">\n </a>\n <a href=\"https://pypi.python.org/pypi/nonebot-plugin-treehelp\">\n <img src=\"https://img.shields.io/pypi/v/nonebot-plugin-treehelp.svg\" alt=\"pypi\">\n </a>\n <img src=\"https://img.shields.io/badge/python-3.8+-blue.svg\" alt=\"python\">\n <a href=\"https://codecov.io/gh/he0119/nonebot-plugin-treehelp\">\n <img src=\"https://codecov.io/gh/he0119/nonebot-plugin-treehelp/branch/main/graph/badge.svg?token=jd5ufc1alv\"/>\n </a>\n <a href=\"https://jq.qq.com/?_wv=1027&k=7zQUpiGp\">\n <img src=\"https://img.shields.io/badge/QQ%E7%BE%A4-730374631-orange?style=flat-square\" alt=\"QQ Chat Group\">\n </a>\n</p>\n\n## \u7b80\u4ecb\n\n\u4f7f\u7528\u63d2\u4ef6\u5143\u6570\u636e\u83b7\u53d6\u63d2\u4ef6\u4fe1\u606f\uff0c\u5e76\u901a\u8fc7\u63d2\u4ef6\u4e0e\u5b50\u63d2\u4ef6\u7684\u7ec4\u7ec7\u5f62\u5f0f\uff0c\u6765\u533a\u5206\u63d2\u4ef6\u7684\u591a\u79cd\u529f\u80fd\u3002\n\n\u6811\u5f62\u5e2e\u52a9\u63d2\u4ef6\uff0c\u6700\u91cd\u8981\u7684\u529f\u80fd\u5f53\u7136\u662f\u663e\u793a\u63d2\u4ef6\u6811\uff01\n\n\u53d1\u9001 `/help --tree`\uff0c\u4f60\u5c06\u83b7\u5f97\u5982\u4e0b\u5e2e\u52a9\uff1a\n\n```text\n\u63d2\u4ef6\uff1a\n\u5e2e\u52a9 # \u83b7\u53d6\u63d2\u4ef6\u5e2e\u52a9\u4fe1\u606f\n\u6d4b\u8bd5 # \u4e00\u4e2a\u6d4b\u8bd5\u63d2\u4ef6\n\u251c\u2500\u2500 \u590d\u6742\u529f\u80fd # \u6d4b\u8bd5\u63d2\u4ef6\u590d\u6742\u5b50\u63d2\u4ef6\n\u2502 \u2514\u2500\u2500 \u4e8c\u7ea7\u529f\u80fd # \u6d4b\u8bd5\u63d2\u4ef6\u4e8c\u7ea7\u63d2\u4ef6\n\u2514\u2500\u2500 \u7b80\u5355\u529f\u80fd # \u6d4b\u8bd5\u63d2\u4ef6\u7b80\u5355\u5b50\u63d2\u4ef6\n```\n\n## \u4f7f\u7528\u65b9\u5f0f\n\n\u52a0\u8f7d\u63d2\u4ef6\u540e\u53d1\u9001 `/help help` \u6216 `/help --help` \u83b7\u53d6\u5177\u4f53\u7528\u6cd5\u3002\n\n## \u63d2\u4ef6\u9002\u914d\n\n\u63d2\u4ef6\u4e0e\u5b50\u63d2\u4ef6\u5199\u6cd5\u53ef\u53c2\u8003 [\u793a\u4f8b\u63d2\u4ef6](./tests/plugins/tree/)\u3002\n\n### \u58f0\u660e\u9002\u914d\u5668\n\n\u901a\u8fc7\u8bbe\u7f6e adapters \u5c5e\u6027\u6765\u6307\u5b9a\u652f\u6301\u7684\u9002\u914d\u5668\u3002\u5982\u679c\u4e0d\u8bbe\u7f6e\u6216\u7559\u7a7a\u5219\u9ed8\u8ba4\u652f\u6301\u5168\u90e8\u9002\u914d\u5668\u3002\u5982\u679c\u63d2\u4ef6\u4e0d\u652f\u6301\u8be5\u9002\u914d\u5668\uff0c\u5219\u4e0d\u4f1a\u5728\u5e2e\u52a9\u5217\u8868\u4e0a\u663e\u793a\u3002\n\n```python\n__plugin_meta__ = PluginMetadata(\n name=\"OneBot\",\n description=\"\u6d4b\u8bd5 OneBot \u9002\u914d\u5668\",\n usage=\"/onebot\",\n type=\"application\",\n supported_adapters={\"~onebot.v11\", \"~onebot.v12\"},\n)\n```\n\n## \u914d\u7f6e\u9879\n\n\u914d\u7f6e\u65b9\u5f0f\uff1a\u76f4\u63a5\u5728 `NoneBot` \u5168\u5c40\u914d\u7f6e\u6587\u4ef6\u4e2d\u6dfb\u52a0\u4ee5\u4e0b\u914d\u7f6e\u9879\u5373\u53ef\u3002\n\n### treehelp_ignored_plugins\n\n- \u7c7b\u578b: `list[str]`\n- \u9ed8\u8ba4: `[]`\n- \u8bf4\u660e: \u9700\u8981\u5ffd\u7565\u7684\u63d2\u4ef6\u540d\u79f0\u5217\u8868\n\n## \u8ba1\u5212\n\n- [ ] \u652f\u6301\u8f93\u51fa\u63d2\u4ef6\u7248\u672c\n- [x] \u652f\u6301\u8f93\u51fa\u63d2\u4ef6\u6811\n- [ ] \u652f\u6301\u8f93\u51fa\u63d2\u4ef6\u5185\u7684\u547d\u4ee4\u540d\u79f0\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "\u9002\u7528\u4e8e Nonebot2 \u7684\u6811\u5f62\u5e2e\u52a9\u63d2\u4ef6",
"version": "0.4.1",
"project_urls": {
"Documentation": "https://github.com/he0119/nonebot-plugin-treehelp#readme",
"Homepage": "https://github.com/he0119/nonebot-plugin-treehelp",
"Repository": "https://github.com/he0119/nonebot-plugin-treehelp"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d3e6008a6ed2ecd111c47a82cc29cb4190c437ec69e10bbaf7de0a41a3250321",
"md5": "b27307b4b522d799e20549f7a8b6a77e",
"sha256": "03cc5271536b9f6033d64eab55509b0280da0ef90875336efbb839a919bc7dc8"
},
"downloads": -1,
"filename": "nonebot_plugin_treehelp-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b27307b4b522d799e20549f7a8b6a77e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 6739,
"upload_time": "2024-03-01T05:09:14",
"upload_time_iso_8601": "2024-03-01T05:09:14.419256Z",
"url": "https://files.pythonhosted.org/packages/d3/e6/008a6ed2ecd111c47a82cc29cb4190c437ec69e10bbaf7de0a41a3250321/nonebot_plugin_treehelp-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0a602411d42a436b258a80275d0696007f2748074d8888195cb4eefe34bfc391",
"md5": "f4b17ad69d20b295f1dbe6e86ac12d0c",
"sha256": "fa9f679b8244d9794037106107baf281927a0432f6607d28fbee18e3c9c64667"
},
"downloads": -1,
"filename": "nonebot_plugin_treehelp-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "f4b17ad69d20b295f1dbe6e86ac12d0c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 5789,
"upload_time": "2024-03-01T05:09:15",
"upload_time_iso_8601": "2024-03-01T05:09:15.952470Z",
"url": "https://files.pythonhosted.org/packages/0a/60/2411d42a436b258a80275d0696007f2748074d8888195cb4eefe34bfc391/nonebot_plugin_treehelp-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-01 05:09:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "he0119",
"github_project": "nonebot-plugin-treehelp",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "nonebot-plugin-treehelp"
}
JSON
