mofox-plugin-dev-toolkit 0.2.1__py3-none-any.whl

mofox_plugin_dev_toolkit-0.2.1.dist-info/METADATA

@@ -0,0 +1,409 @@
+Metadata-Version: 2.4
+Name: mofox-plugin-dev-toolkit
+Version: 0.2.1
+Summary: 开发工具集，用于快速创建、开发和测试 MoFox-Bot 插件
+Author-email: MoFox-Studio <mofox.studio@example.com>
+License: GPL-3.0-or-later
+Project-URL: Homepage, https://github.com/MoFox-Studio/mofox-plugin-toolkit
+Project-URL: Documentation, https://docs.mofox.studio/mpdt
+Project-URL: Repository, https://github.com/MoFox-Studio/mofox-plugin-toolkit
+Project-URL: Bug Tracker, https://github.com/MoFox-Studio/mofox-plugin-toolkit/issues
+Keywords: mofox,plugin,toolkit,cli,development
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.1.7
+Requires-Dist: rich>=13.7.0
+Requires-Dist: questionary>=2.0.1
+Requires-Dist: jinja2>=3.1.2
+Requires-Dist: toml>=0.10.2
+Requires-Dist: tomli>=2.0.1
+Requires-Dist: tomli-w>=1.0.0
+Requires-Dist: pydantic>=2.5.0
+Requires-Dist: watchdog>=3.0.0
+Requires-Dist: websockets>=12.0
+Requires-Dist: aiohttp>=3.9.0
+Requires-Dist: uvicorn>=0.24.0
+Requires-Dist: fastapi>=0.104.0
+Requires-Dist: ruff>=0.1.6
+Requires-Dist: mypy>=1.7.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.3; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.1; extra == "dev"
+Requires-Dist: pytest-mock>=3.12.0; extra == "dev"
+Requires-Dist: mypy>=1.7.0; extra == "dev"
+Requires-Dist: ruff>=0.1.6; extra == "dev"
+Provides-Extra: check
+Requires-Dist: mypy>=1.7.0; extra == "check"
+Requires-Dist: ruff>=0.1.6; extra == "check"
+Requires-Dist: bandit>=1.7.5; extra == "check"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5.3; extra == "docs"
+Requires-Dist: mkdocs-material>=9.4.0; extra == "docs"
+Dynamic: license-file
+
+# MoFox Plugin Dev Toolkit (MPDT)
+
+[![Python Version](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+[![License](https://img.shields.io/badge/license-GPL--3.0-green.svg)](LICENSE)
+[![Version](https://img.shields.io/badge/version-0.1.4-orange.svg)](https://github.com/MoFox-Studio/mofox-plugin-toolkit)
+
+一个类似于 Vite 的 Python 开发工具，专门为 MoFox-Bot 插件系统设计，提供快速创建、开发和检查插件的完整工具链。
+
+## ✨ 特性
+
+- 🚀 **快速初始化** - 一键创建标准化的插件项目结构，支持多种模板（basic、action、tool、command、full、adapter）
+- 🎨 **代码生成** - 快速生成 Action、Command、Tool、Event、Adapter、Prompt、PlusCommand、Router、Chatter 等组件（始终生成异步方法）
+- 🔍 **静态检查** - 集成多层次验证系统：
+  - ✅ 结构检查 - 验证插件目录结构和必需文件
+  - ✅ 元数据检查 - 检查 `__plugin_meta__` 配置
+  - ✅ 组件检查 - 验证组件注册和命名规范
+  - ✅ 配置检查 - 检查 `config.toml` 配置文件
+  - ✅ 类型检查 - 使用 mypy 进行类型检查
+  - ✅ 代码风格检查 - 使用 ruff 检查代码规范
+  - ✅ 自动修复 - 自动修复可修复的代码问题
+- 📦 **依赖管理** - 自动管理插件依赖关系
+- 🎯 **Git 集成** - 支持自动初始化 Git 仓库和提取 Git 用户信息
+- 🎨 **丰富的交互** - 基于 questionary 的美观交互式命令行界面
+- � **多种许可证** - 支持 GPL-v3.0、MIT、Apache-2.0、BSD-3-Clause
+
+## 📦 安装
+
+```bash
+# 从源码安装
+cd mofox-plugin-toolkit
+pip install -e .
+
+# 安装开发依赖
+pip install -e ".[dev]"
+```
+
+## 🚀 快速开始
+
+### 1. 创建新插件
+
+```bash
+# 交互式创建
+mpdt init
+
+# 或直接指定插件名和模板
+mpdt init my_awesome_plugin --template action
+
+# 创建带示例和文档的完整插件
+mpdt init my_plugin --template full --with-examples --with-docs
+
+# 指定作者和许可证
+mpdt init my_plugin --author "Your Name" --license MIT
+```
+
+支持的模板类型：
+- `basic` - 基础插件模板
+- `action` - 包含 Action 组件的模板
+- `tool` - 包含 Tool 组件的模板
+- `command` - 包含 Command 组件的模板
+- `full` - 完整功能模板
+- `adapter` - 适配器模板
+
+### 2. 生成组件
+
+```bash
+cd my_awesome_plugin
+
+# 交互式生成（推荐）
+mpdt generate
+
+# 生成 Action 组件
+mpdt generate action SendMessage --description "发送消息"
+
+# 生成 Tool 组件
+mpdt generate tool MessageFormatter
+
+# 生成 Command 组件
+mpdt generate command Help
+
+# 生成其他组件
+mpdt generate event MessageReceived
+mpdt generate adapter CustomAdapter
+mpdt generate prompt SystemPrompt
+mpdt generate plus-command CustomCommand
+mpdt generate router MessageRouter
+mpdt generate chatter ChatHandler
+```
+
+**注意**：所有生成的组件方法都是异步的（async）。
+
+### 3. 检查插件
+
+```bash
+# 运行所有检查
+mpdt check
+
+# 自动修复问题
+mpdt check --fix
+
+# 只显示错误级别
+mpdt check --level error
+
+# 生成 Markdown 报告
+mpdt check --report markdown --output check_report.md
+
+# 跳过特定检查
+mpdt check --no-type --no-style
+```
+
+检查项包括：
+- 结构检查（structure）- 验证目录和文件结构
+- 元数据检查（metadata）- 检查 `__plugin_meta__`
+- 组件检查（component）- 验证组件注册
+- 配置检查（config）- 检查配置文件
+- 类型检查（type）- mypy 类型检查
+- 代码风格检查（style）- ruff 代码规范检查
+
+## 📖 命令参考
+
+### `mpdt init` - 初始化插件
+
+创建新的插件项目。
+
+```bash
+mpdt init [PLUGIN_NAME] [OPTIONS]
+
+选项:
+  -t, --template TEXT    模板类型: basic, action, tool, command, full, adapter
+  -a, --author TEXT      作者名称
+  -l, --license TEXT     开源协议: GPL-v3.0, MIT, Apache-2.0, BSD-3-Clause
+  --with-examples        包含示例代码
+  --with-docs           创建文档文件
+  --init-git            初始化 Git 仓库
+  --no-init-git         不初始化 Git 仓库
+  -o, --output PATH     输出目录
+```
+
+### `mpdt generate` - 生成组件
+
+生成插件组件代码（始终生成异步方法）。
+
+```bash
+mpdt generate [COMPONENT_TYPE] [COMPONENT_NAME] [OPTIONS]
+
+组件类型:
+  action          Action 组件
+  tool            Tool 组件
+  event           Event Handler 组件
+  adapter         Adapter 组件
+  prompt          Prompt 组件
+  plus-command    PlusCommand 组件
+  router          Router 路由组件
+  chatter         Chatter 聊天组件
+
+选项:
+  -d, --description TEXT  组件描述
+  -o, --output PATH      输出目录
+  -f, --force            覆盖已存在的文件
+```
+
+**注意**：如果不提供参数，将进入交互式问答模式。
+
+### `mpdt check` - 检查插件
+
+对插件进行静态检查。
+
+```bash
+mpdt check [PATH] [OPTIONS]
+
+选项:
+  -l, --level TEXT       显示级别: error, warning, info
+  --fix                  自动修复问题
+  --report TEXT          报告格式: console, markdown
+  -o, --output PATH      报告输出路径
+  --no-structure         跳过结构检查
+  --no-metadata          跳过元数据检查
+  --no-component         跳过组件检查
+  --no-type             跳过类型检查
+  --no-style            跳过代码风格检查
+  --no-security         跳过安全检查
+```
+
+### `mpdt test` - 运行测试 ⚠️ 未实现
+
+运行插件测试（计划中）。
+
+```bash
+mpdt test [TEST_PATH] [OPTIONS]
+
+选项:
+  -c, --coverage         生成覆盖率报告
+  --min-coverage INT     最低覆盖率要求
+  -v, --verbose          详细输出
+  -m, --markers TEXT     只运行特定标记的测试
+  -k, --keyword TEXT     只运行匹配关键词的测试
+  -n, --parallel INT     并行运行测试
+```
+
+### `mpdt dev` - 开发模式 ⚠️ 未实现
+
+启动开发模式，监控文件变化（计划中）。
+
+```bash
+mpdt dev [OPTIONS]
+
+选项:
+  -p, --port INT         开发服务器端口
+  --host TEXT           绑定的主机地址
+  --no-reload           禁用自动重载
+  --debug               启用调试模式
+```
+
+### `mpdt build` - 构建插件 ⚠️ 未实现
+
+构建和打包插件（计划中）。
+
+```bash
+mpdt build [OPTIONS]
+
+选项:
+  -o, --output PATH      输出目录
+  --with-docs           包含文档
+  --format TEXT         构建格式: zip, tar.gz, wheel
+  --bump TEXT           升级版本: major, minor, patch
+```
+
+## 🏗️ 插件结构
+
+MPDT 创建的插件具有以下标准结构：
+
+```
+my_plugin/
+├── __init__.py              # 插件元数据（包含 __plugin_meta__）
+├── plugin.py                # 插件主类
+├── config/
+│   └── config.toml          # 配置文件
+├── components/              # 组件目录（可选）
+│   ├── actions/             # Action 组件
+│   ├── tools/               # Tool 组件
+│   ├── events/              # Event Handler 组件
+│   ├── adapters/            # Adapter 组件
+│   ├── prompts/             # Prompt 组件
+│   ├── plus_commands/       # PlusCommand 组件
+│   ├── routers/             # Router 组件
+│   └── chatters/            # Chatter 组件
+├── utils/                   # 工具函数（可选）
+├── tests/                   # 测试目录（推荐）
+│   ├── conftest.py
+│   └── test_plugin.py
+├── docs/                    # 文档目录（推荐）
+│   └── README.md
+├── pyproject.toml           # Python 项目配置（推荐）
+├── requirements.txt         # 依赖列表（推荐）
+└── README.md               # 插件说明（推荐）
+```
+
+### 必需文件
+- `__init__.py` - 必须包含 `__plugin_meta__` 变量
+- `plugin.py` - 插件主类，继承自 `BasePlugin`
+- `config/config.toml` - 配置文件
+
+### 推荐文件
+- `README.md` - 插件使用说明
+- `pyproject.toml` 或 `requirements.txt` - 依赖管理
+- `tests/` - 测试目录
+- `docs/` - 文档目录
+
+## 🔧 配置
+
+MPDT 支持项目级配置文件 `.mpdtrc.toml`（计划中）：
+
+```toml
+[mpdt]
+project_name = "my_plugin"
+version = "1.0.0"
+
+[mpdt.check]
+level = "warning"
+auto_fix = false
+
+[mpdt.test]
+coverage_threshold = 80
+
+[mpdt.templates]
+author = "Your Name"
+license = "GPL-v3.0"
+```
+
+## 🎯 开发状态
+
+### ✅ 已实现功能
+
+- ✅ **插件初始化** (`mpdt init`)
+  - 支持 6 种模板类型
+  - 交互式问答
+  - Git 集成
+  - 多种许可证支持
+  
+- ✅ **组件生成** (`mpdt generate`)
+  - 支持 8 种组件类型
+  - 自动异步方法生成
+  - 自动更新插件注册
+  - 交互式模式
+
+- ✅ **静态检查** (`mpdt check`)
+  - 结构验证器
+  - 元数据验证器
+  - 组件验证器
+  - 配置验证器
+  - 类型检查器 (mypy)
+  - 代码风格检查器 (ruff)
+  - 自动修复功能
+  - Markdown 报告生成
+
+### 🚧 计划中功能
+
+- 🚧 **测试框架** (`mpdt test`)
+- 🚧 **开发模式** (`mpdt dev`)
+- 🚧 **构建打包** (`mpdt build`)
+
+## 🤝 贡献
+
+欢迎贡献代码和建议！
+
+## 📄 许可证
+
+GPL-3.0-or-later
+
+## 🔗 相关链接
+
+- [MoFox-Bot](https://github.com/MoFox-Studio/MoFox-Bot)
+- [问题反馈](https://github.com/MoFox-Studio/mofox-plugin-toolkit/issues)
+
+## 📊 技术栈
+
+- **CLI 框架**: Click
+- **交互式界面**: Questionary
+- **美化输出**: Rich
+- **模板引擎**: Jinja2
+- **配置管理**: TOML, Pydantic
+- **代码检查**: Mypy (类型检查), Ruff (代码风格)
+- **文件监控**: Watchdog (计划中)
+
+## 🛠️ 核心依赖
+
+```toml
+dependencies = [
+    "click>=8.1.7",
+    "rich>=13.7.0",
+    "questionary>=2.0.1",
+    "jinja2>=3.1.2",
+    "toml>=0.10.2",
+    "pydantic>=2.5.0",
+    "watchdog>=3.0.0",
+    "ruff>=0.1.6",
+    "mypy>=1.7.0"
+]
+```

mofox_plugin_dev_toolkit-0.2.1.dist-info/RECORD

@@ -0,0 +1,43 @@
+mofox_plugin_dev_toolkit-0.2.1.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+mpdt/__init__.py,sha256=X3pswRfdIGeACs92UhMxgbDKIq8wiFh3a6QJPJ8mn78,237
+mpdt/__main__.py,sha256=Xr9RFmCNHeHrRu6BI05AcKhy8U7igtAtWUAzuzKSzNw,107
+mpdt/cli.py,sha256=wY_gwPiDTbkgcE3XXpyn6oZAFJIdn8jqQ64So3VUG_0,11583
+mpdt/commands/__init__.py,sha256=vBX7tJMZfTYjYs9zyTMN3OgLMjiQ1nrZL0XfX7VxaBE,77
+mpdt/commands/check.py,sha256=1QCEtmKy3guteaqQsjBoHrZySa1IfzHmsUavWbngR6o,9605
+mpdt/commands/dev.py,sha256=c0LzV9VrGkJzJWcunge4kFj3mWiyQZxrVpvj1l0xiiA,22273
+mpdt/commands/generate.py,sha256=U91YzMBKZKNUrH3uZhCC5Boj4uZ_QA9sYKO83PcrK-E,11532
+mpdt/commands/init.py,sha256=_9gw4LdPIW4p1cSDgbrrLM35433iJtOTv9_5zGUCMsg,12306
+mpdt/dev/bridge_plugin/__init__.py,sha256=JYkt-pMkkYo4OAKmGJOXz3yXQtNHmWO4l5ZaVOsY-mM,566
+mpdt/dev/bridge_plugin/discovery_server.py,sha256=FGmCRm6ELELxdFmgOz9XorFL4i5a2lci47WWqow5VDQ,3197
+mpdt/dev/bridge_plugin/plugin.py,sha256=0GumPNtMxtdz_xjp1rIeWYNeCz-lfHQtPa9TqxGDXaY,9631
+mpdt/templates/__init__.py,sha256=60-dqCO544oUQL_e09LQ9n_DDueeRD4WiXxpJ47YE2g,4887
+mpdt/templates/action_template.py,sha256=neJj-7II0g-zOtEu5OT_qm0aR9hfpqkzfxyr_IbuJCY,3203
+mpdt/templates/adapter_template.py,sha256=B-PKqzyNY3qRW7_s5_VJOoASzAIWazZCwcY_XgRE3AM,3630
+mpdt/templates/chatter_template.py,sha256=ajfP3Mq8TS4ZoD1xKmmQXd_sdvUnoLZUOUyQkScwzzI,2842
+mpdt/templates/event_template.py,sha256=lCoisjtc6ofIiYraOlqKNMr54lMQFYw_9BSYTmilWgw,3118
+mpdt/templates/plus_command_template.py,sha256=vJfEbnK04pM-COTCzGy3jJgd9-9lm5oMSS5bE4ZjRMc,3869
+mpdt/templates/prompt_template.py,sha256=dxgkhkZl7ID1GNjHx43nOeqUv2RvZfzP8nH8plogS0E,2521
+mpdt/templates/router_template.py,sha256=2pdktVugUFZP1dAF12FaTTfJNT1Js8gwrOGIggvu42k,4588
+mpdt/templates/tool_template.py,sha256=ff7XfsO-cmasH1UG1wp5l7HqGU1XyPzxHTjCcpgQm9Y,2611
+mpdt/utils/__init__.py,sha256=tgk63mzuXKOwZNWbO3yED4LdDntdJLf9ypHWYT9Pv_s,123
+mpdt/utils/color_printer.py,sha256=5WMRRGVu8vmcSg-juty3Eia-n5iBkDRgX3Db6XBWm0E,2626
+mpdt/utils/config_loader.py,sha256=EHwCkKLeUWXTNlZh_zW_7Z1AaeC1AofvE1W-tWUPx2s,4130
+mpdt/utils/config_manager.py,sha256=UFKjzE_sijvjRR88KHZp1AccyVR62nq8kkGLwKNlF80,9923
+mpdt/utils/file_ops.py,sha256=wnpxyqMxYbp7r_62TrxTq_ZzixZMuNqkjd5YDTqu2qk,4368
+mpdt/utils/license_generator.py,sha256=4eksNuqgVaS_7E42JObew65wXcRhi06Q1gck_K1qLlg,50313
+mpdt/utils/plugin_parser.py,sha256=gmGGXag5U3Bfu52ke2JRE-nf8NdmjUh6pCSRf_HNIAI,6507
+mpdt/utils/template_engine.py,sha256=BV0Qku-uTjABhxZa2qWWlTHtbD1b-iDPX0ou3EbIltg,3096
+mpdt/validators/__init__.py,sha256=s9X9v08ZmpPn5YiVVyqRdGi-8dXJHrkMRMxtNk_K9bw,717
+mpdt/validators/auto_fix_validator.py,sha256=halYN0az3gB8V6dv8vKLAkzb50A5oq2jZbiSsVduNFQ,6421
+mpdt/validators/base.py,sha256=LEcDK9KmmQFDULUdxSmp4_RqLIscnNv3dub65bQ0rgE,3278
+mpdt/validators/component_validator.py,sha256=WrL38ko0T8_kMKvUw81I32flCvj56HxAnfCwvzl_bug,14924
+mpdt/validators/config_validator.py,sha256=ip7yTPqFrlsIYw-d2z-jDeRckYhaPZiaYBf7AUsRVT0,6619
+mpdt/validators/metadata_validator.py,sha256=RjWYypfedTDdnc2rPBUWXxtmd9OMEfqAZ3SNwu9n9cw,4443
+mpdt/validators/structure_validator.py,sha256=2u-uN5Asm33tKFDiPY_n8VAKsbHVguJHfNlWbnfALxc,2215
+mpdt/validators/style_validator.py,sha256=Oy_tOrkvSSDyQCMsEwSMMzAIzz5PxIZ18lob9Dg5ffY,3890
+mpdt/validators/type_validator.py,sha256=_lUMLvhfKHyvTNl5LrlDFDJMJr_pxVbGtbNZx-2xL58,7252
+mofox_plugin_dev_toolkit-0.2.1.dist-info/METADATA,sha256=k2LZ69xNqM8NhEVCC5FRu286BouehCvsynGFph73KBk,11833
+mofox_plugin_dev_toolkit-0.2.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+mofox_plugin_dev_toolkit-0.2.1.dist-info/entry_points.txt,sha256=g1nhK041JPGWVSLsrDvWELJvci30gu9u6-cMK8Lj2wY,38
+mofox_plugin_dev_toolkit-0.2.1.dist-info/top_level.txt,sha256=fVLSi-FmHXRO5ex-272DBdGqmDE7yupJdbY8IAFxtgQ,5
+mofox_plugin_dev_toolkit-0.2.1.dist-info/RECORD,,

mofox_plugin_dev_toolkit-0.2.1.dist-info/WHEEL

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

mofox_plugin_dev_toolkit-0.2.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+mpdt = mpdt.cli:cli