NoneBot2 插件开发指南：如何发布你的插件

NoneBot2 插件开发指南：如何发布你的插件

nonebot2 跨平台 Python 异步聊天机器人框架 / Asynchronous multi-platform chatbot framework written in Python 项目地址: https://gitcode.com/gh_mirrors/no/nonebot2

前言

作为一款优秀的 Python 异步机器人框架，NoneBot2 提供了强大的插件机制，让开发者能够轻松扩展机器人功能。本文将详细介绍如何将开发完成的 NoneBot2 插件发布到官方商店，供其他用户使用。

插件发布前的准备工作

命名规范的重要性

在发布插件前，首先要确保插件命名符合规范。良好的命名习惯不仅能提高代码可读性，还能避免与其他插件产生冲突。

• 项目名：建议采用 nonebot-plugin-{your-plugin-name} 格式，使用短横线连接单词
• 模块名：建议采用 nonebot_plugin_{your_plugin_name} 格式，使用下划线连接单词

例如，开发一个天气查询插件：

• 项目名：nonebot-plugin-weather
• 模块名：nonebot_plugin_weather

项目结构建议

合理的项目结构能让插件更易于维护和使用。以下是推荐的基本结构：

nonebot-plugin-weather/
├── nonebot_plugin_weather/
│   ├── __init__.py
│   └── config.py
├── pyproject.toml
└── README.md

其中：

• __init__.py 是插件主文件
• config.py 存放插件配置（可选）
• pyproject.toml 是项目构建配置文件
• README.md 是项目说明文档

插件元数据配置

元数据是插件发布的关键信息，必须正确填写才能通过审核。在插件的 __init__.py 文件中，需要定义 __plugin_meta__ 变量：

from nonebot.plugin import PluginMetadata
from .config import Config

__plugin_meta__ = PluginMetadata(
    name="天气查询",
    description="提供天气查询功能的插件",
    usage="输入'天气 城市名'查询天气",
    type="application",
    homepage="https://example.com/weather-plugin",
    config=Config,
    supported_adapters={"~onebot.v11"}
)

关键字段说明：

• type：插件类型，application表示面向终端用户，library表示面向开发者
• homepage：项目主页，必须填写
• supported_adapters：支持的适配器列表

依赖管理

正确的依赖管理能确保插件在各种环境下正常运行：

1. 必须添加 nonebot2 作为依赖
2. 需要添加使用的适配器依赖，如 nonebot-adapter-onebot
3. 避免使用 nonebot（这是 NoneBot1 的包名）
4. 谨慎使用版本锁定，优先使用兼容性版本范围

文档编写

良好的文档能帮助用户快速上手使用你的插件。README.md 应该包含：

1. 插件功能介绍
2. 安装方法（至少包含 nb-cli 方式）
3. 配置说明（如有）
4. 使用示例
5. 注意事项

发布到 PyPI

发布前请确保：

1. 已注册 PyPI 账号
2. 已安装构建工具（如 poetry、pdm 或 setuptools）

使用 Poetry 发布

poetry build  # 构建包
poetry publish  # 发布包

使用 PDM 发布

pdm build  # 构建包
pdm publish  # 发布包

使用 Setuptools 发布

python -m build  # 构建包
twine upload dist/*  # 上传包

发布后建议立即测试安装，确保一切正常。

提交商店审核

完成 PyPI 发布后，需要提交商店审核：

1. 在商店页面点击"发布插件"
2. 填写插件信息表单
3. 提交审核

审核流程包括：

1. 自动化检查（元数据、加载测试等）
2. 人工代码审查
3. 通过后自动合并到商店

如果审核未通过，可以根据反馈修改后重新提交，无需关闭原有申请。

结语

通过本文的指导，你应该已经掌握了 NoneBot2 插件发布的完整流程。规范的插件开发与发布不仅能提升用户体验，也能促进 NoneBot2 生态的健康发展。期待看到你的优秀插件出现在商店中！

nonebot2 跨平台 Python 异步聊天机器人框架 / Asynchronous multi-platform chatbot framework written in Python 项目地址: https://gitcode.com/gh_mirrors/no/nonebot2