aishipbox 0.1.0__py3-none-any.whl

aishipbox/__init__.py

@@ -0,0 +1,3 @@
+"""aishipbox CLI package."""
+
+__version__ = "0.1.0"

aishipbox/__main__.py

@@ -0,0 +1,6 @@
+import sys
+
+from aishipbox.cli import main
+
+if __name__ == "__main__":
+    sys.exit(main())

aishipbox/algo/__init__.py

@@ -0,0 +1,58 @@
+"""algo subcommand group dispatch."""
+
+from __future__ import annotations
+
+import argparse
+from typing import List
+
+
+def dispatch(argv: List[str]) -> int:
+    parser = argparse.ArgumentParser(prog="aishipbox algo", description="算法包服务项目管理")
+    sub = parser.add_subparsers(dest="cmd", required=True)
+
+    p_new = sub.add_parser("new", help="新建算法服务项目")
+    p_new.add_argument("name")
+    p_new.add_argument("-d", "--dir", default=".")
+    p_new.add_argument("-t", "--template", choices=["basic", "predict", "cv"])
+    p_new.add_argument("--yes", action="store_true")
+
+    p_run = sub.add_parser("run", help="本地运行算法服务")
+    p_run.add_argument("path", nargs="?", default=".")
+    p_run.add_argument("-p", "--port", type=int, default=8080)
+    p_run.add_argument("--host", default="127.0.0.1")
+    p_run.add_argument("--debug", action="store_true")
+    p_run.add_argument("--debug-port", type=int, default=5678)
+
+    p_pack = sub.add_parser("pack", help="打包算法服务")
+    p_pack.add_argument("path", nargs="?", default=".")
+    p_pack.add_argument("-o", "--output")
+
+    p_debug = sub.add_parser("debug", help="生成 VS Code 调试配置")
+    p_debug.add_argument("path", nargs="?", default=".")
+
+    p_stubs = sub.add_parser("stubs", help="安装 IDE 类型补全包")
+    p_stubs.add_argument("path", nargs="?", default=".")
+
+    p_deps = sub.add_parser("install-deps", help="安装托管环境常用依赖")
+    p_deps.add_argument("path", nargs="?", default=".")
+
+    try:
+        args = parser.parse_args(argv)
+    except SystemExit as e:
+        return int(e.code) if e.code is not None else 2
+
+    from aishipbox.algo.commands import new, run, pack, debug, stubs, install_deps
+
+    if args.cmd == "new":
+        return new.execute(args.name, args.dir, args.template, args.yes)
+    if args.cmd == "run":
+        return run.execute(args.path, args.host, args.port, args.debug, args.debug_port)
+    if args.cmd == "pack":
+        return pack.execute(args.path, args.output)
+    if args.cmd == "debug":
+        return debug.execute(args.path)
+    if args.cmd == "stubs":
+        return stubs.execute(args.path)
+    if args.cmd == "install-deps":
+        return install_deps.execute(args.path)
+    return 2

aishipbox/algo/commands/debug.py

@@ -0,0 +1,40 @@
+"""Generate VS Code debug configuration."""
+
+import json
+from pathlib import Path
+
+LAUNCH_CONFIG = {
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Attach to Algo Service",
+            "type": "debugpy",
+            "request": "attach",
+            "connect": {
+                "host": "127.0.0.1",
+                "port": 5678
+            }
+        }
+    ]
+}
+
+
+def execute(path: str) -> int:
+    project_dir = Path(path).resolve()
+    vscode_dir = project_dir / ".vscode"
+    launch_file = vscode_dir / "launch.json"
+
+    vscode_dir.mkdir(exist_ok=True)
+
+    if launch_file.exists():
+        print(f"警告：{launch_file} 已存在，将覆盖")
+
+    launch_file.write_text(json.dumps(LAUNCH_CONFIG, indent=2, ensure_ascii=False), encoding="utf-8")
+    print(f"已生成：{launch_file}")
+
+    print("\n调试步骤：")
+    print("  1. 在代码中设置断点")
+    print("  2. 运行：aishipbox algo run --debug")
+    print("  3. 在 VS Code 中按 F5 附加调试器")
+
+    return 0

aishipbox/algo/commands/install_deps.py

@@ -0,0 +1,47 @@
+"""Install hosting-environment dependencies into the project venv."""
+
+from __future__ import annotations
+
+import subprocess
+from pathlib import Path
+
+from aishipbox.core.venv import python_executable, require_uv, VenvError
+
+
+HOSTING_DEPS = [
+    "numpy",
+    "pandas",
+    "scipy",
+    "scikit-learn",
+    "requests",
+    "flask",
+    "opencv-python",
+    "pillow",
+    "pyyaml",
+    "pydantic",
+    "aiohttp",
+    "openpyxl",
+    "lxml",
+]
+
+
+def execute(path: str = ".") -> int:
+    project_dir = Path(path).resolve()
+    try:
+        py = python_executable(project_dir)
+        uv = require_uv()
+    except VenvError as e:
+        print(str(e))
+        return 1
+
+    print("安装托管环境常用依赖...")
+    print(f"  包：{', '.join(HOSTING_DEPS)}\n")
+
+    cmd = [uv, "pip", "install", "--python", str(py)] + HOSTING_DEPS
+    result = subprocess.run(cmd, text=True)
+    if result.returncode != 0:
+        print("\n错误：部分依赖安装失败")
+        return 1
+
+    print("\n完成：托管环境依赖已安装到项目 .venv/。")
+    return 0

aishipbox/algo/commands/new.py

@@ -0,0 +1,96 @@
+"""algo new: create a new algorithm service project."""
+
+from __future__ import annotations
+
+from importlib import resources
+from pathlib import Path
+from string import Template
+from typing import Optional
+
+from aishipbox import __version__
+from aishipbox.core import strings
+from aishipbox.core.config import HOSTED_RUNTIMES, ProjectConfig, write_project_config
+from aishipbox.core.ui import stdin_is_interactive
+from aishipbox.core.venv import provision_venv, pip_install
+
+
+TEMPLATES = ("basic", "predict", "cv")
+TEMPLATE_DEPS = {
+    "basic": ["requests"],
+    "predict": ["pandas", "requests"],
+    "cv": ["opencv-python", "numpy", "requests"],
+}
+
+
+def execute(name: str, parent_dir: str, template: Optional[str] = None, yes: bool = False) -> int:
+    if "-" in name:
+        print(f"项目名不允许包含连字符：{name}，请改用下划线 {name.replace('-', '_')}")
+        return 1
+
+    parent = Path(parent_dir).resolve()
+    project_dir = parent / name
+    if project_dir.exists():
+        print(strings.TARGET_DIR_EXISTS.format(path=project_dir))
+        return 1
+
+    if template is None:
+        if yes:
+            template = "basic"
+        elif not stdin_is_interactive():
+            print(strings.NON_INTERACTIVE_NO_WIZARD.format(
+                example=f"aishipbox algo new {name} --yes -t basic"
+            ))
+            return 2
+        else:
+            template = _prompt_template()
+    if template not in TEMPLATES:
+        print(f"未知模板：{template}")
+        return 1
+
+    project_dir.mkdir(parents=True)
+
+    template_pkg = resources.files(f"aishipbox.algo.templates.{template}")
+    for item in template_pkg.iterdir():
+        if item.is_file() and not item.name.startswith("__"):
+            content = item.read_text(encoding="utf-8").replace("${name}", name)
+            (project_dir / item.name).write_text(content, encoding="utf-8")
+
+    agents_tmpl = resources.files("aishipbox.algo.templates").joinpath("AGENTS.md.tmpl").read_text(encoding="utf-8")
+    (project_dir / "AGENTS.md").write_text(
+        Template(agents_tmpl).safe_substitute(aishipbox_version=__version__),
+        encoding="utf-8",
+    )
+
+    write_project_config(project_dir, ProjectConfig(type="algo", runtime=HOSTED_RUNTIMES["algo"]))
+
+    _provision_and_install(project_dir, template)
+
+    print(f"\n项目已创建：{project_dir}")
+    print(f"\n{strings.NEXT_STEPS_HEADER}")
+    print(f"  1. cd {name}")
+    print(f"  2. cp .env.example .env  # 如存在")
+    print(f"  3. 编辑 main.py 实现算法")
+    print(f"  4. aishipbox algo run")
+    print(f"  5. aishipbox algo pack")
+    return 0
+
+
+def _prompt_template() -> str:
+    print(strings.ALGO_SELECT_TEMPLATE)
+    print(f"  1. {strings.ALGO_TEMPLATE_BASIC}")
+    print(f"  2. {strings.ALGO_TEMPLATE_PREDICT}")
+    print(f"  3. {strings.ALGO_TEMPLATE_CV}")
+    while True:
+        choice = input("请输入编号或名称 [1]：").strip() or "1"
+        mapping = {"1": "basic", "2": "predict", "3": "cv",
+                   "basic": "basic", "predict": "predict", "cv": "cv"}
+        if choice in mapping:
+            return mapping[choice]
+        print(f"无效选择：{choice}")
+
+
+def _provision_and_install(project_dir: Path, template: str) -> None:
+    provision_venv(project_dir, HOSTED_RUNTIMES["algo"])
+    deps = TEMPLATE_DEPS.get(template, [])
+    if deps:
+        pip_install(project_dir, *deps)

aishipbox/algo/commands/pack.py

@@ -0,0 +1,32 @@
+"""algo pack: build a .tar.gz of the service for deployment."""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Optional
+
+from aishipbox.core.packaging import DEFAULT_EXCLUDES, build_tar
+
+
+ALGO_EXCLUDES = DEFAULT_EXCLUDES | {
+    ".aishipbox.toml",
+    "AGENTS.md",
+    ".env.example",
+    "server.py",
+    "run.py",
+    "pack.py",
+    "test_client.py",
+    "rest",
+}
+
+
+def execute(path: str, output: Optional[str] = None) -> int:
+    service_dir = Path(path).resolve()
+    if not (service_dir / "main.py").exists():
+        print(f"main.py 不存在：{service_dir}")
+        return 1
+
+    out_path = Path(output) if output else Path(f"{service_dir.name}.tar.gz")
+    build_tar(service_dir, out_path, excludes=ALGO_EXCLUDES, gzip=True)
+    print(f"已生成：{out_path}")
+    return 0

aishipbox/algo/commands/run.py

@@ -0,0 +1,42 @@
+"""algo run: launch the local HTTP server using the project's venv."""
+
+from __future__ import annotations
+
+import os
+import subprocess
+from pathlib import Path
+
+from aishipbox.core.env import load_env_file
+from aishipbox.core.venv import python_executable, VenvError
+
+
+def execute(path: str, host: str, port: int, debug: bool, debug_port: int) -> int:
+    service_dir = Path(path).resolve()
+    main_file = service_dir / "main.py"
+    if not main_file.exists():
+        print(f"main.py 不存在：{service_dir}")
+        return 1
+
+    try:
+        py = python_executable(service_dir)
+    except VenvError as e:
+        print(str(e))
+        return 1
+
+    env = os.environ.copy()
+    env.update(load_env_file(service_dir / ".env"))
+    env.update({
+        "ALGO_SERVICE_DIR": str(service_dir),
+        "ALGO_HOST": host,
+        "ALGO_PORT": str(port),
+        "ALGO_DEBUG": "1" if debug else "0",
+        "ALGO_DEBUG_PORT": str(debug_port),
+    })
+
+    runner_script = Path(__file__).resolve().parent.parent / "runner.py"
+
+    try:
+        result = subprocess.run([str(py), str(runner_script)], env=env, cwd=str(service_dir.parent))
+        return result.returncode
+    except KeyboardInterrupt:
+        return 0

aishipbox/algo/commands/stubs.py

@@ -0,0 +1,31 @@
+"""Install stub packages for IDE/linting support into the project venv."""
+
+from __future__ import annotations
+
+import subprocess
+from importlib import resources
+from pathlib import Path
+
+from aishipbox.core.venv import python_executable, require_uv, VenvError
+
+
+def execute(path: str = ".") -> int:
+    project_dir = Path(path).resolve()
+    try:
+        py = python_executable(project_dir)
+        uv = require_uv()
+    except VenvError as e:
+        print(str(e))
+        return 1
+
+    stubs_dir = resources.files("aishipbox.algo.stubs")
+    with resources.as_file(stubs_dir) as stubs_path:
+        print(f"安装 rest-stubs：{stubs_path}")
+        cmd = [uv, "pip", "install", "--python", str(py), str(stubs_path)]
+        result = subprocess.run(cmd, capture_output=True, text=True)
+        if result.returncode != 0:
+            print(f"错误：{result.stderr}")
+            return 1
+        print("已安装 rest-stubs")
+        print("\n'rest.process_base' 现在可以被解析（IDE 类型提示）。")
+        return 0

aishipbox/algo/runner.py

@@ -0,0 +1,126 @@
+"""Runner script executed in the user's virtual environment."""
+
+import json
+import logging
+import os
+import sys
+from http.server import BaseHTTPRequestHandler, HTTPServer
+from pathlib import Path
+
+logging.basicConfig(
+    level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s"
+)
+logger = logging.getLogger(__name__)
+
+
+PROCESS_BASE_STUB = '''
+class ProcessBase:
+    def __init__(self, url: str = ""):
+        self.url = url
+'''
+
+
+def create_handler(processor):
+    """Create HTTP handler with processor instance."""
+
+    class AlgoHandler(BaseHTTPRequestHandler):
+        def do_POST(self):
+            content_length = int(self.headers.get("Content-Length", 0))
+            body = self.rfile.read(content_length)
+
+            try:
+                params = json.loads(body)
+                result, status_code = processor.process(params)
+
+                self.send_response(status_code)
+                self.send_header("Content-Type", "application/json")
+                self.end_headers()
+                self.wfile.write(json.dumps(result, ensure_ascii=False).encode("utf-8"))
+            except json.JSONDecodeError:
+                self.send_error(400, "Invalid JSON")
+            except Exception as e:
+                logger.exception("Error processing request")
+                self.send_error(500, str(e))
+
+        def do_GET(self):
+            if self.path == "/health":
+                self.send_response(200)
+                self.send_header("Content-Type", "application/json")
+                self.end_headers()
+                self.wfile.write(b'{"status": "ok"}')
+            else:
+                self.send_error(404, "Not Found")
+
+    return AlgoHandler
+
+
+def main():
+    # Read configuration from environment
+    service_dir = Path(os.environ["ALGO_SERVICE_DIR"]).resolve()
+    host = os.environ["ALGO_HOST"]
+    port = int(os.environ["ALGO_PORT"])
+    debug = os.environ.get("ALGO_DEBUG") == "1"
+    debug_port = int(os.environ.get("ALGO_DEBUG_PORT", "5678"))
+
+    service_name = service_dir.name
+
+    if debug:
+        try:
+            import debugpy
+            debugpy.listen(("0.0.0.0", debug_port))
+            logger.info(f"Debugger listening on port {debug_port}")
+            logger.info("Waiting for VS Code to attach (press F5)...")
+            debugpy.wait_for_client()
+            logger.info("Debugger attached")
+        except ImportError:
+            logger.error("debugpy not installed. Install it with: pip install debugpy")
+            return 1
+
+    # Inject ProcessBase stub into rest.process_base
+    import types
+    rest_module = types.ModuleType("rest")
+    process_base_module = types.ModuleType("rest.process_base")
+    exec(PROCESS_BASE_STUB, process_base_module.__dict__)
+    rest_module.process_base = process_base_module
+    sys.modules["rest"] = rest_module
+    sys.modules["rest.process_base"] = process_base_module
+
+    # Add parent directory to path for absolute imports
+    sys.path.insert(0, str(service_dir.parent))
+
+    try:
+        # Import as package to match production environment
+        import importlib
+        main_module = importlib.import_module(f"{service_name}.main")
+        AlgoProcessor = main_module.AlgoProcessor
+    except ImportError as e:
+        logger.error(f"Error importing AlgoProcessor: {e}")
+        return 1
+
+    processor = AlgoProcessor()
+    handler = create_handler(processor)
+
+    try:
+        server = HTTPServer((host, port), handler)
+    except OSError as e:
+        if e.errno == 48:  # Address already in use
+            logger.error(f"Port {port} is already in use.")
+            logger.error(f"Try: algo run --port {port + 1}")
+            return 1
+        raise
+
+    logger.info(f"Starting server at http://{host}:{port}")
+    logger.info(f"POST http://{host}:{port}/  - Process request")
+    logger.info(f"GET  http://{host}:{port}/health - Health check")
+
+    try:
+        server.serve_forever()
+    except KeyboardInterrupt:
+        logger.info("Shutting down")
+        server.shutdown()
+
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

aishipbox/algo/stubs/__init__.py

@@ -0,0 +1 @@
+"""Stub packages for local development."""

aishipbox/algo/stubs/pyproject.toml

@@ -0,0 +1,12 @@
+[project]
+name = "rest-stubs"
+version = "0.1.0"
+description = "Stub package for hosting platform rest module"
+requires-python = ">=3.9"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["rest"]

aishipbox/algo/stubs/rest/__init__.py

@@ -0,0 +1 @@
+"""Stub package for rest module (provided by hosting platform at runtime)."""

aishipbox/algo/stubs/rest/process_base.py

@@ -0,0 +1,6 @@
+"""Stub for rest.process_base module (provided by hosting platform at runtime)."""
+
+
+class ProcessBase:
+    def __init__(self, url: str = ""):
+        self.url = url

aishipbox/algo/templates/AGENTS.md.tmpl

@@ -0,0 +1,22 @@
+# AGENTS.md
+
+本项目类型：算法包服务（algo）
+托管运行时：Python 3.9
+工具：aishipbox v${aishipbox_version}
+
+## 入口
+- main.py 中的 `AlgoProcessor` 类
+
+## 常用命令
+- 本地运行：    aishipbox algo run
+- 启动调试：    aishipbox algo run --debug   （需配合 VS Code "Attach to Algo Service"）
+- 打包：        aishipbox algo pack
+- 安装托管依赖：aishipbox algo install-deps
+
+## 关键约束
+- 部署到 MAS 托管服务，结构遵循 main.py + requirements.txt + dependency/。
+- requirements.txt 中可引用 dependency/ 下的离线 wheel。
+- 不要修改 .aishipbox.toml 的 schema_version 与 type 字段。
+
+## 平台参考
+- 算法手册：参见 MAS 文档

aishipbox/algo/templates/__init__.py

@@ -0,0 +1 @@
+"""algo-cli templates."""

aishipbox/algo/templates/basic/.env.example

@@ -0,0 +1,5 @@
+# ${name} Configuration
+# Copy this file to .env and fill in the values
+
+# Model service URL (if calling external model)
+# MODEL_URL=http://localhost:8080/predict

aishipbox/algo/templates/basic/__init__.py

@@ -0,0 +1 @@
+"""${name} algorithm service."""

aishipbox/algo/templates/basic/main.py

@@ -0,0 +1,27 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""${name} - Algorithm Service Entry Point."""
+
+from __future__ import annotations
+
+import logging
+
+from rest.process_base import ProcessBase
+from .utils import example_function
+
+logging.basicConfig(
+    level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s"
+)
+logger = logging.getLogger(__name__)
+
+
+class AlgoProcessor(ProcessBase):
+    """Algorithm Processor - maintains API compatibility with hosting platform."""
+
+    def __init__(self):
+        super().__init__(url="")
+
+    def process(self, params_dict: dict) -> tuple[dict, int]:
+        value = params_dict.get("value", "default")
+        result = example_function(value)
+        return {"result": result}, 200

aishipbox/algo/templates/basic/requirements.txt

@@ -0,0 +1,13 @@
+# 在此添加基础镜像中未包含的依赖
+# 将 .whl 文件放入 dependency/ 文件夹，并按以下格式引用：
+#   dependency/your-package-1.0.0-py3-none-any.whl
+#
+# 基础镜像已安装的包（请勿重复添加）：
+#   核心库: numpy==1.26.4, pandas==2.1.2, scipy==1.11.2
+#   机器学习: scikit-learn==1.0.2, xgboost==1.6.2, lightgbm==3.3.5
+#   深度学习: tensorflow==2.16.1, keras==3.9.0, torch==1.13.1
+#   图像处理: opencv-python==4.7.0.72, pillow==11.2.1
+#   数据处理: pyarrow==20.0.0, openpyxl==3.1.2, lxml==5.4.0
+#   网络框架: flask==3.0.0, requests==2.32.0, aiohttp==3.12.11, gunicorn==22.0.0
+#   分布式: ray==2.46.0
+#   工具库: pyyaml==6.0.2, pydantic==1.10.21, cryptography==45.0.3

aishipbox/algo/templates/basic/utils.py

@@ -0,0 +1,6 @@
+"""Example utility module for ${name}."""
+
+
+def example_function(value: str) -> str:
+    """Example utility function."""
+    return f"Processed: {value}"

aishipbox/algo/templates/cv/.env.example

@@ -0,0 +1,5 @@
+# ${name} Configuration
+# Copy this file to .env and fill in the values
+
+# Model service URL
+MODEL_URL=http://localhost:8080/predict

aishipbox/algo/templates/cv/__init__.py

@@ -0,0 +1 @@
+"""${name} algorithm service."""