未提供项目说明
nonebot-plugin-rauthman的Python项目详细描述
nonebot_plugin_rauthman
- 基于 nonebot / nonebot2 https://github.com/nonebot/nonebot2
功能
- 基于规则的授权管理
开始使用
建议使用 poetry
- 通过 poetry 添加到 nonebot2 项目的 pyproject.toml
poetry add nonebot-plugin-rauthman
- 通过 pip 从 PyPI 安装
pip install nonebot-plugin-rauthman
- 在 nonebot2 项目中设置 load_plugin()
当使用 nb-cli 添加本插件时,该条会被自动添加
nonebot.load_plugin('nonebot_plugin_rauthman')
- 参照下文在 nonebot2 项目的环境文件 .env.* 中添加配置项
配置项
授权管理信息保存位置(必须):
savedata: str
保存相对路径,示例意为保存至运行目录下的'Yuni/savedata'
目录
savedata = 'Yuni/savedata'
授权管理应用策略(可选):
0
根据可用功能授权,当功能在群聊的可用服务列表内时为可用(默认值)1
根据服务级别授权,当群聊级别不低于功能所需级别时为可用
auth_policy = 0
授权管理指令所需的参数(可选):
auth_command: str
指令名,唯一触发用,默认为'auth'
auth_add: str
启用功能的开关,唯一触发用,默认为'-a'
auth_rm: str
禁用功能的开关,唯一触发用,默认为'-rm'
auth_command = 'auth' auth_add = '-a' auth_rm = '-rm'
- 为需要管理的 on_* 事件设置规则授权,示例意为将一个
on_command
事件划入一个名为servicename
服务,同时设置服务级别1
from nonebot.plugin import on_command from nonebot_plugin_rauthman import isInService command = on_command('cmd', rule=isInService('servicename', 1))
- 这样,群聊必须被启用了该服务,或服务级别高于指定值(取决于当前应用的授权管理应用策略)才能进入事件处理
特别感谢
- Mrs4s / go-cqhttp https://github.com/Mrs4s/go-cqhttp
- nonebot / nonebot2 https://github.com/nonebot/nonebot2
优化建议
如有优化建议请积极提交 Issues 或 Pull requests
- 项目
标签: