https://github.com/a-kirami/nonebot-plugin-template

nonebot2 插件模板库
https://github.com/a-kirami/nonebot-plugin-template

Last synced: 17 days ago
JSON representation

nonebot2 插件模板库

• Host: GitHub
• URL: https://github.com/a-kirami/nonebot-plugin-template
• Owner: A-kirami
• Created: 2022-04-27T08:42:54.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-08-08T13:09:28.000Z (3 months ago)
• Last Synced: 2024-10-18T18:19:27.561Z (18 days ago)
• Homepage:
• Size: 37.1 KB
• Stars: 78
• Watchers: 1
• Forks: 29
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  

  


  






# nonebot-plugin-template

_✨ NoneBot 插件简单描述 ✨_



    





    







这是一个 nonebot2 插件项目的模板库, 你可以直接使用本模板创建你的 nonebot2 插件项目的仓库

模板库使用方法

1. 点击 [![start-course](https://user-images.githubusercontent.com/1221423/235727646-4a590299-ffe5-480d-8cd5-8194ea184546.svg)](https://github.com/new?template_owner=A-kirami&template_name=nonebot-plugin-template&owner=%40me&name=nonebot-plugin-&visibility=public) 创建仓库

2. 在创建好的新仓库中, 在 "Add file" 菜单中选择 "Create new file", 在新文件名处输入`LICENSE`, 此时在右侧会出现一个 "Choose a license template" 按钮, 点击此按钮选择开源协议模板, 然后在最下方提交新文件到主分支

3. 全局替换`owner`为仓库所有者ID; 全局替换`nonebot-plugin-template`为插件名; 全局替换`nonebot_plugin_template`为包名; 修改 python 徽标中的版本为你插件的运行所需版本

4. 修改 README 中的插件名和插件描述, 并在下方填充相应的内容

> [!NOTE]

> 模板库中自带了一个发布工作流, 你可以使用此工作流自动发布你的插件到 pypi

配置发布工作流

1. 前往 https://pypi.org/manage/account/#api-tokens 并创建一个新的 API 令牌。创建成功后不要关闭页面，不然你将无法再次查看此令牌。

2. 在单独的浏览器选项卡或窗口中，打开 [Actions secrets and variables](./settings/secrets/actions) 页面。你也可以在 Settings - Secrets and variables - Actions 中找到此页面。

3. 点击 New repository secret 按钮，创建一个名为 `PYPI_API_TOKEN` 的新令牌，并从第一步复制粘贴令牌。

> [!IMPORTANT]

> 这个发布工作流需要 pyproject.toml 文件, 并且只支持 [PEP 621](https://peps.python.org/pep-0621/) 标准的 pyproject.toml 文件

触发发布工作流

从本地推送任意 tag 即可触发。

创建 tag:

    git tag 

推送本地所有 tag:

    git push origin --tags

## 📖 介绍

这里是插件的详细介绍部分

## 💿 安装

使用 nb-cli 安装

在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装

    nb plugin install nonebot-plugin-template

使用包管理器安装

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

pip

    pip install nonebot-plugin-template

pdm

    pdm add nonebot-plugin-template

poetry

    poetry add nonebot-plugin-template

conda

    conda install nonebot-plugin-template

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

    plugins = ["nonebot_plugin_template"]

## ⚙️ 配置

在 nonebot2 项目的`.env`文件中添加下表中的必填配置

| 配置项 | 必填 | 默认值 | 说明 |

|:-----:|:----:|:----:|:----:|

| 配置项1 | 是 | 无 | 配置说明 |

| 配置项2 | 否 | 无 | 配置说明 |

## 🎉 使用

### 指令表

| 指令 | 权限 | 需要@ | 范围 | 说明 |

|:-----:|:----:|:----:|:----:|:----:|

| 指令1 | 主人 | 否 | 私聊 | 指令说明 |

| 指令2 | 群员 | 是 | 群聊 | 指令说明 |

### 效果图

如果有效果图的话