mofox-plugin-dev-toolkit 0.5.1__tar.gz → 0.5.2__tar.gz

{mofox_plugin_dev_toolkit-0.5.1/mofox_plugin_dev_toolkit.egg-info → mofox_plugin_dev_toolkit-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mofox-plugin-dev-toolkit
-Version: 0.5.1
+Version: 0.5.2
 Summary: 开发工具集，用于快速创建、开发和测试 MoFox-Bot 插件
 Author-email: MoFox-Studio <wwwww95915@qq.com>
 License: GPL-3.0-or-later
@@ -30,6 +30,7 @@ Requires-Dist: watchdog>=3.0.0
 Requires-Dist: websockets>=12.0
 Requires-Dist: libcst>=1.8.6
 Requires-Dist: aiohttp>=3.9.0
+Requires-Dist: pillow>=11.2.0
 Requires-Dist: uvicorn>=0.24.0
 Requires-Dist: fastapi>=0.104.0
 Requires-Dist: ruff>=0.1.6

{mofox_plugin_dev_toolkit-0.5.1 → mofox_plugin_dev_toolkit-0.5.2/mofox_plugin_dev_toolkit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mofox-plugin-dev-toolkit
-Version: 0.5.1
+Version: 0.5.2
 Summary: 开发工具集，用于快速创建、开发和测试 MoFox-Bot 插件
 Author-email: MoFox-Studio <wwwww95915@qq.com>
 License: GPL-3.0-or-later
@@ -30,6 +30,7 @@ Requires-Dist: watchdog>=3.0.0
 Requires-Dist: websockets>=12.0
 Requires-Dist: libcst>=1.8.6
 Requires-Dist: aiohttp>=3.9.0
+Requires-Dist: pillow>=11.2.0
 Requires-Dist: uvicorn>=0.24.0
 Requires-Dist: fastapi>=0.104.0
 Requires-Dist: ruff>=0.1.6

{mofox_plugin_dev_toolkit-0.5.1 → mofox_plugin_dev_toolkit-0.5.2}/mofox_plugin_dev_toolkit.egg-info/requires.txt

@@ -10,6 +10,7 @@ watchdog>=3.0.0
 websockets>=12.0
 libcst>=1.8.6
 aiohttp>=3.9.0
+pillow>=11.2.0
 uvicorn>=0.24.0
 fastapi>=0.104.0
 ruff>=0.1.6

{mofox_plugin_dev_toolkit-0.5.1 → mofox_plugin_dev_toolkit-0.5.2}/mpdt/commands/build.py

@@ -181,14 +181,14 @@ def _save_manifest(plugin_dir: Path, manifest: dict) -> None:
         json.dump(manifest, f, ensure_ascii=False, indent=4)
 
 
-def _validate_manifest_metadata(manifest: dict) -> None:
+def _validate_manifest_metadata(manifest: dict, plugin_dir: Path) -> None:
     """验证打包所需的 manifest 元数据。"""
     required = ["name", "version", "description", "author", "entry_point"]
     for field in required:
         if field not in manifest:
             raise ValueError(f"manifest.json 缺少必需字段: '{field}'")
 
-    errors = metadata_errors(manifest)
+    errors = metadata_errors(manifest, plugin_dir)
     if errors:
         raise ValueError(errors[0])
 
@@ -279,7 +279,7 @@ def build_package(
 
     manifest = ensure_manifest_metadata_interactive(plugin_dir, manifest)
 
-    _validate_manifest_metadata(manifest)
+    _validate_manifest_metadata(manifest, plugin_dir)
 
     plugin_name: str = manifest["name"]
     plugin_version: str = manifest["version"]

{mofox_plugin_dev_toolkit-0.5.1 → mofox_plugin_dev_toolkit-0.5.2}/mpdt/commands/init.py

@@ -369,9 +369,11 @@ def _generate_manifest_file(
 
     manifest = {
         "name": plugin_name,
+        "display_name": plugin_name,
         "version": "1.0.0",
         "description": description or f"{plugin_name} 插件",
         "author": author or "Your Name",
+        "icon": "icon.png",
         "categories": categories or ["tool"],
         "tags": tags or [plugin_name],
         "dependencies": {"plugins": [], "components": []},

{mofox_plugin_dev_toolkit-0.5.1 → mofox_plugin_dev_toolkit-0.5.2}/mpdt/commands/market.py

@@ -51,7 +51,7 @@ def market_register(plugin_path: str = ".", market_url: str | None = None, token
 
     async def run() -> None:
         manifest = await _load_manifest_for_market(plugin_path)
-        payload = plugin_payload(manifest, repository_url=repository_url)
+        payload = plugin_payload(manifest, repository_url=repository_url, plugin_dir=plugin_path)
         result = await _client(market_url, token).register_plugin(payload)
         _print_ok(f"Plugin registered: {result['plugin_id']} ({result['status']})")
 
@@ -63,7 +63,7 @@ def market_update(plugin_path: str = ".", market_url: str | None = None, token:
 
     async def run() -> None:
         manifest = await _load_manifest_for_market(plugin_path)
-        payload = plugin_payload(manifest, repository_url=repository_url)
+        payload = plugin_payload(manifest, repository_url=repository_url, plugin_dir=plugin_path)
         plugin_id = payload.pop("plugin_id")
         result = await _client(market_url, token).update_plugin(plugin_id, payload)
         _print_ok(f"Plugin updated: {result['plugin_id']} ({result['status']})")
@@ -232,7 +232,7 @@ def market_publish(
         asset_url = str(asset.get("browser_download_url") or asset_download_url_for(plugin_id, version, package.package_path.name))
 
         market = _client(market_url, token or github_api_token)
-        plugin_registration_payload = plugin_payload(manifest, repository_url=repo_html_url)
+        plugin_registration_payload = plugin_payload(manifest, repository_url=repo_html_url, plugin_dir=plugin_dir)
         try:
             plugin = await market.register_plugin(plugin_registration_payload)
             _print_ok(f"Plugin registered: {plugin['plugin_id']} ({plugin['status']})")

{mofox_plugin_dev_toolkit-0.5.1 → mofox_plugin_dev_toolkit-0.5.2}/mpdt/market/manifest.py

@@ -2,10 +2,14 @@
 
 from __future__ import annotations
 
+import base64
+import io
 import json
 from pathlib import Path
 from typing import Any
 
+from PIL import Image, ImageOps
+
 
 def load_manifest(plugin_path: str = ".") -> dict[str, Any]:
     """Load manifest.json from a plugin directory."""
@@ -20,16 +24,24 @@ def load_manifest(plugin_path: str = ".") -> dict[str, Any]:
     return data
 
 
-def plugin_payload(manifest: dict[str, Any], repository_url: str | None = None) -> dict[str, Any]:
+def plugin_payload(
+    manifest: dict[str, Any],
+    repository_url: str | None = None,
+    plugin_dir: str | Path | None = None,
+) -> dict[str, Any]:
     """Convert MPDT manifest.json to market plugin registration payload."""
 
     plugin_id = str(manifest.get("name") or "").strip()
     if not plugin_id:
         raise ValueError("manifest.json 缺少 name 字段")
+    display_name = str(manifest.get("display_name") or "").strip()
+    if not display_name:
+        raise ValueError("manifest.json 缺少 display_name 字段")
     repo = repository_url or manifest.get("repository_url") or f"https://github.com/MoFox-Studio/{plugin_id}"
+    resolved_plugin_dir = Path(plugin_dir).resolve() if plugin_dir is not None else None
     return {
         "plugin_id": plugin_id,
-        "display_name": str(manifest.get("display_name") or plugin_id),
+        "display_name": display_name,
         "summary": str(manifest.get("summary") or manifest.get("description") or f"{plugin_id} 插件"),
         "description": str(manifest.get("description") or ""),
         "homepage": manifest.get("homepage") or repo,
@@ -38,6 +50,9 @@ def plugin_payload(manifest: dict[str, Any], repository_url: str | None = None)
         "categories": list(manifest.get("categories") or []),
         "tags": list(manifest.get("tags") or []),
         "maintainers": _maintainers(manifest),
+        "plugin_dependencies": list(((manifest.get("dependencies") or {}).get("plugins") or [])),
+        "icon_png_base64": _icon_png_base64(manifest, resolved_plugin_dir),
+        "readme_markdown": _readme_markdown(resolved_plugin_dir),
     }
 
 
@@ -100,3 +115,44 @@ def _maintainers(manifest: dict[str, Any]) -> list[str]:
         return [str(item) for item in maintainers]
     author = str(manifest.get("author") or "mock-author").strip()
     return [author or "mock-author"]
+
+
+def _icon_png_base64(manifest: dict[str, Any], plugin_dir: Path | None) -> str | None:
+    """Return a normalized base64 PNG icon for upload, if configured."""
+
+    raw_icon = str(manifest.get("icon") or "").strip()
+    if not raw_icon:
+        return None
+    if plugin_dir is None:
+        raise ValueError("manifest.json 包含 icon 字段，但当前上下文缺少插件目录")
+    icon_path = (plugin_dir / raw_icon).resolve() if not Path(raw_icon).is_absolute() else Path(raw_icon)
+    if not icon_path.exists() or not icon_path.is_file():
+        raise ValueError(f"manifest.json 的 icon 指向的文件不存在: {icon_path}")
+    if icon_path.suffix.lower() != ".png":
+        raise ValueError("manifest.json 的 icon 必须指向 PNG 文件")
+
+    with Image.open(icon_path) as image:
+        if (image.format or "").upper() != "PNG":
+            raise ValueError("manifest.json 的 icon 必须是有效的 PNG 图片")
+        working = ImageOps.contain(image.convert("RGBA"), (512, 512), method=Image.Resampling.LANCZOS)
+
+    canvas = Image.new("RGBA", (512, 512), (0, 0, 0, 0))
+    offset = ((512 - working.width) // 2, (512 - working.height) // 2)
+    canvas.paste(working, offset, working)
+    normalized = canvas.convert("P", palette=Image.Palette.ADAPTIVE, colors=256)
+
+    buffer = io.BytesIO()
+    normalized.save(buffer, format="PNG", optimize=True)
+    return base64.b64encode(buffer.getvalue()).decode("ascii")
+
+
+def _readme_markdown(plugin_dir: Path | None) -> str | None:
+    """Load README.md contents for market detail rendering when present."""
+
+    if plugin_dir is None:
+        return None
+    readme_path = plugin_dir / "README.md"
+    if not readme_path.exists() or not readme_path.is_file():
+        return None
+    content = readme_path.read_text(encoding="utf-8").strip()
+    return content or None

{mofox_plugin_dev_toolkit-0.5.1 → mofox_plugin_dev_toolkit-0.5.2}/mpdt/utils/manifest_metadata.py

@@ -15,6 +15,15 @@ from .color_printer import print_success, print_warning
 ALLOWED_CATEGORIES = ("tool", "chat", "fun", "information", "moderation")
 
 
+def get_display_name(manifest: dict[str, Any]) -> str:
+    """Return normalized display_name from manifest."""
+
+    value = manifest.get("display_name")
+    if not isinstance(value, str):
+        return ""
+    return value.strip()
+
+
 def get_categories(manifest: dict[str, Any]) -> list[str]:
     """Return normalized categories from manifest."""
     value = manifest.get("categories")
@@ -60,14 +69,19 @@ def tags_are_valid(manifest: dict[str, Any]) -> bool:
     return bool(get_tags(manifest))
 
 
-def metadata_errors(manifest: dict[str, Any]) -> list[str]:
+def metadata_errors(manifest: dict[str, Any], plugin_dir: Path | None = None) -> list[str]:
     """Return validation errors for required manifest metadata."""
     errors: list[str] = []
+    if not get_display_name(manifest):
+        errors.append("manifest.json 的 display_name 必须是非空字符串")
     if not categories_are_valid(manifest):
         allowed = ", ".join(ALLOWED_CATEGORIES)
         errors.append(f"manifest.json 的 categories 必须是只包含一个值的数组，且取值只能是: {allowed}")
     if not tags_are_valid(manifest):
         errors.append("manifest.json 的 tags 必须是至少包含一个非空字符串的数组")
+    icon_error = _icon_error(manifest, plugin_dir)
+    if icon_error:
+        errors.append(icon_error)
     return errors
 
 
@@ -99,13 +113,22 @@ def _save_manifest(plugin_dir: Path, manifest: dict[str, Any]) -> None:
         json.dump(manifest, f, ensure_ascii=False, indent=4)
 
 
-def prompt_manifest_metadata(existing_manifest: dict[str, Any] | None = None) -> dict[str, list[str]]:
+def prompt_manifest_metadata(existing_manifest: dict[str, Any] | None = None) -> dict[str, Any]:
     """Collect required manifest metadata from the console."""
     manifest = existing_manifest or {}
+    display_name = get_display_name(manifest) or str(manifest.get("name") or "").strip()
     existing_categories = get_categories(manifest)
     default_category = existing_categories[0] if existing_categories else ALLOWED_CATEGORIES[0]
     existing_tags = ", ".join(get_tags(manifest))
 
+    resolved_display_name = questionary.text(
+        "填写插件展示名 display_name:",
+        default=display_name,
+        validate=lambda value: bool(str(value).strip()) or "display_name 不能为空",
+    ).ask()
+    if resolved_display_name is None:
+        raise ValueError("已取消填写 display_name")
+
     category = questionary.select(
         "选择插件分类 categories（只能选一个）:",
         choices=[questionary.Choice(item, value=item) for item in ALLOWED_CATEGORIES],
@@ -123,18 +146,28 @@ def prompt_manifest_metadata(existing_manifest: dict[str, Any] | None = None) ->
         raise ValueError("已取消填写 tags")
 
     return {
+        "display_name": str(resolved_display_name).strip(),
         "categories": [category],
         "tags": normalize_tags(tags_text),
     }
 
 
-async def prompt_manifest_metadata_async(existing_manifest: dict[str, Any] | None = None) -> dict[str, list[str]]:
+async def prompt_manifest_metadata_async(existing_manifest: dict[str, Any] | None = None) -> dict[str, Any]:
     """Collect required manifest metadata from the console inside an event loop."""
     manifest = existing_manifest or {}
+    display_name = get_display_name(manifest) or str(manifest.get("name") or "").strip()
     existing_categories = get_categories(manifest)
     default_category = existing_categories[0] if existing_categories else ALLOWED_CATEGORIES[0]
     existing_tags = ", ".join(get_tags(manifest))
 
+    resolved_display_name = await questionary.text(
+        "填写插件展示名 display_name:",
+        default=display_name,
+        validate=lambda value: bool(str(value).strip()) or "display_name 不能为空",
+    ).ask_async()
+    if resolved_display_name is None:
+        raise ValueError("已取消填写 display_name")
+
     category = await questionary.select(
         "选择插件分类 categories（只能选一个）:",
         choices=[questionary.Choice(item, value=item) for item in ALLOWED_CATEGORIES],
@@ -152,6 +185,7 @@ async def prompt_manifest_metadata_async(existing_manifest: dict[str, Any] | Non
         raise ValueError("已取消填写 tags")
 
     return {
+        "display_name": str(resolved_display_name).strip(),
         "categories": [category],
         "tags": normalize_tags(tags_text),
     }
@@ -159,14 +193,14 @@ async def prompt_manifest_metadata_async(existing_manifest: dict[str, Any] | Non
 
 def ensure_manifest_metadata_interactive(plugin_dir: Path, manifest: dict[str, Any]) -> dict[str, Any]:
     """Prompt for missing manifest metadata and persist it when running in a TTY."""
-    errors = metadata_errors(manifest)
+    errors = metadata_errors(manifest, plugin_dir)
     if not errors:
         return _finalize_manifest_metadata(manifest)
 
     if not _is_interactive_terminal() or _has_running_event_loop():
         return manifest
 
-    print_warning("检测到 manifest.json 缺少或无效的 categories/tags，进入交互补全...")
+    print_warning("检测到 manifest.json 缺少或无效的市场元数据，进入交互补全...")
     for error in errors:
         print_warning(error)
 
@@ -174,20 +208,20 @@ def ensure_manifest_metadata_interactive(plugin_dir: Path, manifest: dict[str, A
     _finalize_manifest_metadata(manifest)
     _save_manifest(plugin_dir, manifest)
 
-    print_success("已更新 manifest.json 中的 categories 和 tags")
+    print_success("已更新 manifest.json 中的市场元数据")
     return manifest
 
 
 async def ensure_manifest_metadata_interactive_async(plugin_dir: Path, manifest: dict[str, Any]) -> dict[str, Any]:
     """Async prompt for missing manifest metadata and persist it when running in a TTY."""
-    errors = metadata_errors(manifest)
+    errors = metadata_errors(manifest, plugin_dir)
     if not errors:
         return _finalize_manifest_metadata(manifest)
 
     if not _is_interactive_terminal():
         return manifest
 
-    print_warning("检测到 manifest.json 缺少或无效的 categories/tags，进入交互补全...")
+    print_warning("检测到 manifest.json 缺少或无效的市场元数据，进入交互补全...")
     for error in errors:
         print_warning(error)
 
@@ -195,5 +229,23 @@ async def ensure_manifest_metadata_interactive_async(plugin_dir: Path, manifest:
     _finalize_manifest_metadata(manifest)
     _save_manifest(plugin_dir, manifest)
 
-    print_success("已更新 manifest.json 中的 categories 和 tags")
-    return manifest
+    print_success("已更新 manifest.json 中的市场元数据")
+    return manifest
+
+
+def _icon_error(manifest: dict[str, Any], plugin_dir: Path | None) -> str | None:
+    """Return a validation error for the optional icon field, if any."""
+
+    icon = manifest.get("icon")
+    if icon is None or str(icon).strip() == "":
+        return None
+    if not isinstance(icon, str):
+        return "manifest.json 的 icon 必须是字符串路径"
+    if plugin_dir is None:
+        return None
+    icon_path = plugin_dir / icon
+    if not icon_path.exists() or not icon_path.is_file():
+        return f"manifest.json 的 icon 指向的文件不存在: {icon}"
+    if icon_path.suffix.lower() != ".png":
+        return "manifest.json 的 icon 必须指向 .png 文件"
+    return None

{mofox_plugin_dev_toolkit-0.5.1 → mofox_plugin_dev_toolkit-0.5.2}/mpdt/validators/metadata_validator.py

@@ -72,11 +72,11 @@ class MetadataValidator(BaseValidator):
         else:
             self.result.add_info("所有必需的元数据字段都已提供")
 
-        for error in metadata_errors(manifest_data):
+        for error in metadata_errors(manifest_data, self.plugin_path):
             self.result.add_error(
                 error,
                 file_path="manifest.json",
-                suggestion='请填写 "categories": ["tool|chat|fun|information|moderation"] 和 "tags": ["..."]',
+                suggestion='请填写 display_name，并补全 categories/tags；如果配置了 icon，请确保它指向有效的 PNG 文件',
             )
 
         # 检查推荐字段

{mofox_plugin_dev_toolkit-0.5.1 → mofox_plugin_dev_toolkit-0.5.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "mofox-plugin-dev-toolkit"
-version = "0.5.1"
+version = "0.5.2"
 description = "开发工具集，用于快速创建、开发和测试 MoFox-Bot 插件"
 authors = [
     {name = "MoFox-Studio", email = "wwwww95915@qq.com"}
@@ -35,6 +35,7 @@ dependencies = [
     "websockets>=12.0",
     "libcst>=1.8.6",
     "aiohttp>=3.9.0",
+    "pillow>=11.2.0",
     "uvicorn>=0.24.0",
     "fastapi>=0.104.0",
     "ruff>=0.1.6",