nonebot-plugin-template 0.0.1__py3-none-any.whl

nonebot_plugin_template/__init__.py

@@ -0,0 +1,31 @@
+from nonebot import (
+    require,  # noqa: F401
+    get_driver,  # @get_driver().on_startup 装饰启动时运行函数  # noqa: F401
+    get_bots,  # dict[str, BaseBot] 常用于定时器获取 BOT 对象  # noqa: F401
+)
+from nonebot.plugin import (
+    PluginMetadata,
+    inherit_supported_adapters
+)
+
+require("nonebot_plugin_uninfo")
+require("nonebot_plugin_alconna")
+require("nonebot_plugin_localstore")
+require("nonebot_plugin_apscheduler")
+
+from .config import Config  # noqa: E402
+
+
+__plugin_meta__ = PluginMetadata(
+    name="名称",
+    description="描述",
+    usage="用法",
+    type="application",  # library
+    homepage="https://github.com/用户名/nonebot-plugin-",
+    config=Config,
+    supported_adapters=inherit_supported_adapters(
+        "nonebot_plugin_alconna", "nonebot_plugin_uninfo"
+    ),
+    # supported_adapters={"~onebot.v11"},
+    extra={"author": "fllesser <fllessive@gmail.com>"},
+)

nonebot_plugin_template/config.py

@@ -0,0 +1,24 @@
+from nonebot import (
+    get_driver,
+    get_plugin_config
+)
+from pydantic import BaseModel
+from pathlib import Path
+from typing import List, Literal, Optional  # noqa: F401
+
+from nonebot_plugin_apscheduler import scheduler  # noqa: F401
+import nonebot_plugin_localstore as store
+
+class Config(BaseModel):
+    pass
+
+cache_dir: Path = store.get_plugin_cache_dir()
+config_dir: Path = store.get_plugin_config_dir()
+data_dir: Path = store.get_plugin_data_dir()
+
+# 配置加载
+config: Config = get_plugin_config(Config)
+gconfig = get_driver().config
+
+# 全局名称
+NICKNAME: str = next(iter(gconfig.nickname), None)

nonebot_plugin_template/matcher.py

@@ -0,0 +1,17 @@
+from nonebot_plugin_alconna import on_alconna  # noqa: F401
+from arclet.alconna import (
+    Args,
+    Alconna,
+    Option,
+    Subcommand
+)
+
+alc = Alconna(
+    "pip",
+    Subcommand(
+        "install",
+        Args["package", str],
+        Option("-r|--requirement", Args["file", str]),
+        Option("-i|--index-url", Args["url", str]),
+    )
+)

nonebot_plugin_template-0.0.1.dist-info/METADATA

@@ -0,0 +1,144 @@
+Metadata-Version: 2.2
+Name: nonebot-plugin-template
+Version: 0.0.1
+Summary: 插件描述
+Author-email: fllesser <fllessive@gmail.com>
+Requires-Python: <3.13,>=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: httpx<1.0.0,>=0.27.0
+Requires-Dist: nonebot2<3.0.0,>=2.4.0
+Requires-Dist: nonebot-adapter-onebot<3.0.0,>=2.4.6
+Requires-Dist: nonebot-plugin-uninfo<1.0.0,>=0.6.5
+Requires-Dist: nonebot-plugin-alconna<1.0.0,>=0.54.2
+Requires-Dist: nonebot-plugin-localstore<1.0.0,>=0.7.3
+Requires-Dist: nonebot-plugin-apscheduler<1.0.0,>=0.5.0
+
+<div align="center">
+  <a href="https://v2.nonebot.dev/store"><img src="https://github.com/fllesser/nonebot-plugin-template/blob/master/.docs/NoneBotPlugin.svg" width="380" height="177" alt="NoneBotPluginLogo"></a>
+</div>
+
+<div align="center">
+
+# nonebot-plugin-PPPPP
+
+_✨ NoneBot 插件简单描述 ✨_
+
+
+<a href="./LICENSE">
+    <img src="https://img.shields.io/github/license/owner/nonebot-plugin-PPPPP.svg" alt="license">
+</a>
+<a href="https://pypi.python.org/pypi/nonebot-plugin-PPPPP">
+    <img src="https://img.shields.io/pypi/v/nonebot-plugin-PPPPP.svg" alt="pypi">
+</a>
+<img src="https://img.shields.io/badge/python-3.10+-blue.svg" alt="python">
+
+</div>
+
+这是一个 nonebot2 插件项目的模板库, 你可以直接使用本模板创建你的 nonebot2 插件项目的仓库
+
+<details open>
+<summary>模板库使用方法</summary>
+
+1. 点击 [![start-course](https://user-images.githubusercontent.com/1221423/235727646-4a590299-ffe5-480d-8cd5-8194ea184546.svg)](https://github.com/new?template_owner=fllesser&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; 全局替换`PPPPP`为插件名; 全局替换`ppppp`为包名; 修改 python 徽标中的版本为你插件的运行所需版本
+4. 修改 README 中的插件名和插件描述, 并在下方填充相应的内容
+
+</details>
+
+> [!NOTE]
+> 模板库中自带了一个发布工作流, 你可以使用此工作流自动发布你的插件到 pypi
+
+<details>
+<summary>配置发布工作流</summary>
+
+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` 的新令牌，并从第一步复制粘贴令牌。
+
+</details>
+
+> [!IMPORTANT]
+> 这个发布工作流需要 pyproject.toml 文件, 并且只支持 [PEP 621](https://peps.python.org/pep-0621/) 标准的 pyproject.toml 文件
+
+<details>
+<summary>触发发布工作流</summary>
+从本地推送任意 tag 即可触发。
+
+创建 tag:
+
+    git tag <tag_name>
+
+推送本地所有 tag:
+
+    git push origin --tags
+
+</details>
+
+## 📖 介绍
+
+这里是插件的详细介绍部分
+
+## 💿 安装
+
+<details open>
+<summary>使用 nb-cli 安装</summary>
+在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
+
+    nb plugin install nonebot-plugin-PPPPP --upgrade
+
+    nb plugin install nonebot-plugin-PPPPP --upgrade -i "https://pypi.org/simple"
+
+
+</details>
+
+<details>
+<summary>使用包管理器安装</summary>
+在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令
+
+<details>
+<summary>pip</summary>
+
+    pip install nonebot-plugin-PPPPP --upgrade -i "https://pypi.org/simple"
+
+</details>
+<details>
+<summary>pdm</summary>
+
+    pdm add nonebot-plugin-PPPPP
+</details>
+<details>
+<summary>poetry</summary>
+
+    poetry add nonebot-plugin-PPPPP
+</details>
+<details>
+<summary>conda</summary>
+
+    conda install nonebot-plugin-PPPPP
+</details>
+
+打开 nonebot2 项目根目录下的 `pyproject.toml` 文件, 在 `[tool.nonebot]` 部分追加写入
+
+    plugins = ["nonebot_plugin_ppppp"]
+
+</details>
+
+## ⚙️ 配置
+
+在 nonebot2 项目的`.env`文件中添加下表中的必填配置
+
+| 配置项 | 必填 | 默认值 | 说明 |
+|:-----:|:----:|:----:|:----:|
+| 配置项1 | 是 | 无 | 配置说明 |
+| 配置项2 | 否 | 无 | 配置说明 |
+
+## 🎉 使用
+### 指令表
+| 指令 | 权限 | 需要@ | 范围 | 说明 |
+|:-----:|:----:|:----:|:----:|:----:|
+| 指令1 | 主人 | 否 | 私聊 | 指令说明 |
+| 指令2 | 群员 | 是 | 群聊 | 指令说明 |
+
+### 效果图
+如果有效果图的话

nonebot_plugin_template-0.0.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+nonebot_plugin_template/__init__.py,sha256=MQm6rVkCjzOQC1vTLcjdK-JgtGFV-2ZBBGXvLHcP11Q,922
+nonebot_plugin_template/config.py,sha256=Gkka6rMAONFvMaoOk3_DFlC0nnPCir6H4jpYQlA475s,614
+nonebot_plugin_template/matcher.py,sha256=P4b3WPXJUfnhyv44y7DxIhTejeG6TLfbg4IR10rWJ8s,348
+nonebot_plugin_template-0.0.1.dist-info/METADATA,sha256=jUf1SEzCjQR5WU-vAdWtZRuw6bPdIjqwBBUajKRXowM,4814
+nonebot_plugin_template-0.0.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+nonebot_plugin_template-0.0.1.dist-info/top_level.txt,sha256=G7Xv7ZOVFivKfzV_DWOOUNTBvgiGJ7_jdvJejWUwOB4,24
+nonebot_plugin_template-0.0.1.dist-info/RECORD,,

nonebot_plugin_template-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.8.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

nonebot_plugin_template-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+nonebot_plugin_template