Skip to main content

axtbot-plugin-help

✨ 该插件为官方插件包之一,通过/help提供帮助菜单 ✨

pypi python

这是一个使用 PDM 作为包管理器的 AxTBot 插件项目的模板库, 你可以直接使用本模板创建你的 AxTBot 插件项目的仓库

模板库使用方法
  1. 点击仓库中的 "Use this template" 按钮, 输入仓库名与描述, 点击 " Create repository from template" 创建仓库

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

  3. 本地机器首先需要安装 git, python 3.9+ 和 pdm 2.13+

  4. 克隆你刚刚创建的仓库到本地, 并进入仓库目录, 执行 pdm sync 安装虚拟环境与依赖

  5. 利用编辑器打开仓库目录, 执行以下全局替换操作:

    • 全局替换axtbot-plugin-help 为你插件的包名 (用于 pip 安装等)
    • 全局替换axtbot_plugin_help 为你插件的包名 (用于 python 导入等)
    • 全局替换帮助菜单 为你插件的可读名 (用于插件商店 等)
    • 全局替换该插件为官方插件包之一,通过/help提供帮助菜单 为你插件的简单描述
    • 全局替换AxT-Team 为你的 github 用户名
    • 全局替换shanshui@shanshui.site 为你的邮箱
  6. 修改 README 中的插件名和插件描述, 并在下方填充相应的内容

配置发布工作流

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

  1. 前往 https://pypi.org/ 并注册一个账号。
  2. 前往 https://pypi.org/manage/account/publishing/, 下翻到 Pending publishers
  3. 选择 Github 选项栏,填写相关信息:
    • PyPI Project Name: 你的插件包名,如 axtbot-plugin-template
    • Owner: 你的 Github 用户名
    • Repository name: 你的插件仓库名称,如 axtbot-plugin-template
    • Workflow name: 请填入 release.yml
  4. 点击 Add 按钮,完成发布工作流配置
触发发布工作流
  1. 任意提交后,在 Github 仓库界面点击 Releases 选项,点击 Create a new release 按钮。若没有 Release 选项,可在仓库主页点击 Tags 选项,在新界面点击 Create a new release 按钮
  2. 点击 Choose a tag,输入以 v 开头的版本号,如 v0.0.1,然后点击 Create new tag 按钮
  3. 填写 Release titleDescribe this release。或点击 Generate release notes 自动生成相关信息
  4. 点击 Publish release 按钮,触发发布工作流

介绍

[!NOTE] 注意:本存库灵感来源于作者 RF-Tar-Railtnonebot-plugin-template 项目

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

安装方法

使用包管理器安装 在项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令
pip
pip install axtbot-plugin-help
pdm
pdm add axtbot-plugin-help
poetry
poetry add axtbot-plugin-help

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

plugins = ["axtbot_plugin_help"]

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

axtbot_plugin_help-1.0.0.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

axtbot_plugin_help-1.0.0-py3-none-any.whl (3.9 kB view details)

Uploaded Python 3

File details

Details for the file axtbot_plugin_help-1.0.0.tar.gz.

File metadata

  • Download URL: axtbot_plugin_help-1.0.0.tar.gz
  • Upload date:
  • Size: 3.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: pdm/2.28.0 CPython/3.12.3 Linux/6.17.0-1020-azure

File hashes

Hashes for axtbot_plugin_help-1.0.0.tar.gz
Algorithm Hash digest
SHA256 e7f2ab00e69b0dffe96381abee944e188623d07407617295df945103208709a8
MD5 75def1c18c6a9423c08765ae22b9766f
BLAKE2b-256 fa666b49ab8830aaba9b7754a01ba84b2ecb8edbcbd85038c1f5b97e2706a99f

See more details on using hashes here.

File details

Details for the file axtbot_plugin_help-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: axtbot_plugin_help-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 3.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: pdm/2.28.0 CPython/3.12.3 Linux/6.17.0-1020-azure

File hashes

Hashes for axtbot_plugin_help-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0ddc6a31aa4cc6aeb0b839ae121d76e29caab8cea0c2496798357ad1a39e64af
MD5 3842ee5cfd565fa8a55835b38686ff3a
BLAKE2b-256 b3e62a917546f140ffd4afb46bb78d2997a7fea7a0994bd025f17374062d7384

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page