Skip to main content

nonebot2 plugin 自动生成载入插件的帮助信息,响应 /help !help help 菜单 caidan /i

Project description

nonebot-plugin-autohelp

nonebot2betaonebotpythonCode style: blackLicense: MITPyPI version

Show a summary of commands, aliases and usages for plugins loaded

Dependent adapter

onebotv11

Install it

pip install nonebot-plugin-autohelp
# or poetry add nonebot-plugin-autohelp
# pip install git+htts://github.com/ffreemt/nonebot-plugin-autohelp
# poetry add git+htts://github.com/ffreemt/nonebot-plugin-autohelp

# To upgrade
pip install nonebot-plugin-autohelp -U
# or poetry add nonebot-plugin-autohelp@latest

Use it

# bot.py
import nonebot
from nonebot.adapters.onebot.v11 import Adapter
...
nonebot.init()

driver = nonebot.get_driver()
driver.register_adapter(Adapter)

nonebot.load_from_toml("pyproject.toml")
nonebot.load_builtin_plugin("echo")
nonebot.load_plugin("nonebot_plugin_guess")

nonebot.load_plugin("nonebot_plugin_autohelp")

# plugin loaded after autohelp will not be taken care of by autohelp
nonebot.load_plugin("nonebot_plugin_fancy")

Sample session in a qq group

mu (μ)(41947782)  11:23:34 AM
help
mubot(2129462094)  11:23:36 AM
nickname:
command_start: /
command_sep: .

command: say
command: mecho
	aliases: ping, ryt, 在不, p

command: news
	aliases: xinwen, 新闻, 无聊

command: debug test: %s
	aliases: 爬, fetch, crawl

command: guess
	aliases: cai, 猜猜看, (help -d will display detailed docs for all plugins loaded before nonebot_plugin_autohelp)

mu (μ)(41947782)  11:53:25 AM
help -h
mubot(2129462094)  11:53:27 AM
usage: help [-h] [-d] [params [params ...]]

positional arguments:
  params         list of parameters of type str (default: None)

optional arguments:
  -h, --help     show this help message and exit
  -d, --details  show __doc__ for each plugin (default: False)
---

mu (μ)(41947782)  11:23:34 AM
help --details  # or help details
...(attach __doc___ for each plugin, ommitted)

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-autohelp-0.1.7.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

nonebot_plugin_autohelp-0.1.7-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file nonebot-plugin-autohelp-0.1.7.tar.gz.

File metadata

  • Download URL: nonebot-plugin-autohelp-0.1.7.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.1 CPython/3.8.10 Windows/10

File hashes

Hashes for nonebot-plugin-autohelp-0.1.7.tar.gz
Algorithm Hash digest
SHA256 f057c572899d7c119899a565199780ab50ef40db2e7d734e8e33bea6c7fcbc38
MD5 d20ef36d2bd1c078d6de2c77f8293c7a
BLAKE2b-256 ae1266e7e311086cb7dcb09d771765a60db4fae4007a37cc0db22b9c7515a24f

See more details on using hashes here.

File details

Details for the file nonebot_plugin_autohelp-0.1.7-py3-none-any.whl.

File metadata

File hashes

Hashes for nonebot_plugin_autohelp-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 70faef1a7f05a42a448e4d886a4b4a58611d86260df7d6f6e2e2b9deb0e49472
MD5 d591188a6ebc59f5004c5b843ec646c7
BLAKE2b-256 fcc0f6e010f1d0ae8bf2e8fe067ea031b0debb3f764f5480022903f5e5179471

See more details on using hashes here.

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