devops-analyzer 0.1.0__tar.gz

devops_analyzer-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ZHUHK
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

devops_analyzer-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include LICENSE README.md requirements.txt
+include devops/scan/scan.h

devops_analyzer-0.1.0/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: devops-analyzer
+Version: 0.1.0
+Summary: 扫描源码、提取代码块、大模型分析并生成 README.md
+Author: ZHUHK
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/example/devops-analyzer
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: tree-sitter<0.22,>=0.21.0
+Requires-Dist: tree-sitter-languages>=1.10.0
+Requires-Dist: openai>=1.40.0
+Provides-Extra: zhipuai
+Requires-Dist: zhipuai>=2.0.0; extra == "zhipuai"
+Provides-Extra: all
+Requires-Dist: zhipuai>=2.0.0; extra == "all"
+Provides-Extra: build
+Requires-Dist: build>=1.2.0; extra == "build"
+Dynamic: license-file
+
+# Devops Analyzer
+
+扫描项目源码 → Tree-sitter 提取代码块 → 大模型分析 → 生成 `README.md`。
+
+## 安装
+
+```bash
+cd /path/to/Devops
+conda activate devops
+pip install -e .
+
+# 使用智谱 AI 时额外安装
+pip install zhipuai
+```
+
+## 首次使用：配置模型 API
+
+**必须先配置你自己的 API Key**，再分析项目：
+
+```bash
+devops config
+```
+
+按提示选择提供商、输入 API Key 和模型名称。配置保存在 `~/.devops/config.json`（仅当前用户可读）。
+
+查看当前配置（Key 脱敏显示）：
+
+```bash
+devops config --show
+```
+
+## 支持的模型提供商
+
+| 提供商 | `provider` 值 | 默认模型 | 说明 |
+|--------|---------------|----------|------|
+| OpenAI | `openai` | `gpt-4o-mini` | 官方或自定义 Base URL |
+| 智谱 AI | `zhipuai` | `glm-4-flash` | 需 `pip install zhipuai` |
+| DeepSeek | `deepseek` | `deepseek-chat` | OpenAI 兼容协议 |
+| Moonshot | `moonshot` | `moonshot-v1-8k` | OpenAI 兼容协议 |
+
+也可用环境变量覆盖（优先级低于配置文件）：
+
+```bash
+export DEVOPS_PROVIDER=openai
+export DEVOPS_API_KEY=sk-...
+export DEVOPS_MODEL=gpt-4o-mini
+export DEVOPS_BASE_URL=https://api.openai.com/v1   # 可选
+```
+
+## 分析项目
+
+```bash
+devops /path/to/your/project
+
+# 或显式子命令
+devops analyze /path/to/your/project
+
+# 指定输出文件
+devops /path/to/project -o README.md
+
+# 临时覆盖模型（不改配置文件）
+devops /path/to/project --provider deepseek --model deepseek-chat
+```
+
+## 命令一览
+
+```bash
+devops config              # 交互式配置 API
+devops config --show       # 查看配置
+devops <项目路径>          # 分析并生成 README.md
+devops analyze <项目路径>
+devops --help
+devops --version
+```

devops_analyzer-0.1.0/README.md

@@ -0,0 +1,74 @@
+# Devops Analyzer
+
+扫描项目源码 → Tree-sitter 提取代码块 → 大模型分析 → 生成 `README.md`。
+
+## 安装
+
+```bash
+cd /path/to/Devops
+conda activate devops
+pip install -e .
+
+# 使用智谱 AI 时额外安装
+pip install zhipuai
+```
+
+## 首次使用：配置模型 API
+
+**必须先配置你自己的 API Key**，再分析项目：
+
+```bash
+devops config
+```
+
+按提示选择提供商、输入 API Key 和模型名称。配置保存在 `~/.devops/config.json`（仅当前用户可读）。
+
+查看当前配置（Key 脱敏显示）：
+
+```bash
+devops config --show
+```
+
+## 支持的模型提供商
+
+| 提供商 | `provider` 值 | 默认模型 | 说明 |
+|--------|---------------|----------|------|
+| OpenAI | `openai` | `gpt-4o-mini` | 官方或自定义 Base URL |
+| 智谱 AI | `zhipuai` | `glm-4-flash` | 需 `pip install zhipuai` |
+| DeepSeek | `deepseek` | `deepseek-chat` | OpenAI 兼容协议 |
+| Moonshot | `moonshot` | `moonshot-v1-8k` | OpenAI 兼容协议 |
+
+也可用环境变量覆盖（优先级低于配置文件）：
+
+```bash
+export DEVOPS_PROVIDER=openai
+export DEVOPS_API_KEY=sk-...
+export DEVOPS_MODEL=gpt-4o-mini
+export DEVOPS_BASE_URL=https://api.openai.com/v1   # 可选
+```
+
+## 分析项目
+
+```bash
+devops /path/to/your/project
+
+# 或显式子命令
+devops analyze /path/to/your/project
+
+# 指定输出文件
+devops /path/to/project -o README.md
+
+# 临时覆盖模型（不改配置文件）
+devops /path/to/project --provider deepseek --model deepseek-chat
+```
+
+## 命令一览
+
+```bash
+devops config              # 交互式配置 API
+devops config --show       # 查看配置
+devops <项目路径>          # 分析并生成 README.md
+devops analyze <项目路径>
+devops --help
+devops --version
+```

devops_analyzer-0.1.0/devops/__init__.py

@@ -0,0 +1,3 @@
+"""Devops：扫描源码、提取代码块、大模型分析并生成 README。"""
+
+__version__ = "0.1.0"

devops_analyzer-0.1.0/devops/__main__.py

@@ -0,0 +1,3 @@
+from devops.cli import main
+
+raise SystemExit(main())

devops_analyzer-0.1.0/devops/analysis.py

@@ -0,0 +1,234 @@
+"""调用大模型 API 分析 extract 提取的代码块。"""
+
+from __future__ import annotations
+
+from collections import defaultdict
+from datetime import datetime, timezone
+from pathlib import Path
+from typing import Any
+
+from devops.extract import CodeBlock, extract_blocks_from_paths
+from devops.models import BaseChatModel, get_chat_model
+
+MAX_CODE_LINES = 80
+MAX_CHARS_PER_REQUEST = 24_000
+
+SYSTEM_PROMPT = """你是一名资深代码审查专家。
+请根据给出的代码块，输出简洁、结构化的中文分析，包含：
+1. 文件/模块职责概述
+2. 主要函数/类的作用
+3. 潜在问题或改进建议（如有）
+4. 关键依赖或调用关系（如能看出）
+
+直接输出分析正文，不要重复粘贴完整源码。"""
+
+
+def _truncate_code(code: str, max_lines: int = MAX_CODE_LINES) -> str:
+    lines = code.splitlines()
+    if len(lines) <= max_lines:
+        return code
+    head = "\n".join(lines[:max_lines])
+    return f"{head}\n# ... (省略 {len(lines) - max_lines} 行)"
+
+
+def _format_blocks_for_prompt(blocks: list[CodeBlock]) -> str:
+    parts: list[str] = []
+    for i, block in enumerate(blocks, 1):
+        title = block.name or "(anonymous)"
+        parts.append(
+            f"### 块 {i}: {block.block_type} `{title}` "
+            f"(L{block.start_line}-L{block.end_line})\n"
+            f"```{block.language}\n{_truncate_code(block.code)}\n```"
+        )
+    return "\n\n".join(parts)
+
+
+def _chat(model: BaseChatModel, prompt: str) -> str:
+    return model.chat(SYSTEM_PROMPT, prompt, temperature=0.2)
+
+
+def analyze_blocks(
+    blocks: list[CodeBlock],
+    *,
+    provider: str | None = None,
+    api_key: str | None = None,
+    model_name: str | None = None,
+    base_url: str | None = None,
+) -> dict[str, Any]:
+    """按文件分批调用大模型，并生成总览。"""
+    chat_model = get_chat_model(
+        provider=provider,
+        api_key=api_key,
+        model=model_name,
+        base_url=base_url,
+    )
+
+    if not blocks:
+        return {
+            "summary": "未提取到任何代码块，请确认目录内有支持的源码文件。",
+            "files": [],
+            "blocks_count": 0,
+        }
+
+    by_file: dict[str, list[CodeBlock]] = defaultdict(list)
+    for block in blocks:
+        by_file[block.file_path].append(block)
+
+    per_file: list[dict[str, Any]] = []
+    file_summaries: list[str] = []
+
+    for file_path, file_blocks in sorted(by_file.items()):
+        body = _format_blocks_for_prompt(file_blocks)
+        if len(body) > MAX_CHARS_PER_REQUEST:
+            body = body[:MAX_CHARS_PER_REQUEST] + "\n\n...(内容过长已截断)"
+
+        prompt = (
+            f"文件路径: {file_path}\n"
+            f"语言: {file_blocks[0].language}\n"
+            f"代码块数量: {len(file_blocks)}\n\n"
+            f"{body}"
+        )
+        analysis = _chat(chat_model, prompt)
+        per_file.append(
+            {
+                "file_path": file_path,
+                "blocks_count": len(file_blocks),
+                "analysis": analysis,
+            }
+        )
+        file_summaries.append(f"【{file_path}】\n{analysis}")
+
+    overview_prompt = (
+        "以下是多个源文件的逐项分析，请生成一份项目级总览（中文）：\n"
+        "1. 项目整体结构\n"
+        "2. 各文件之间的关系\n"
+        "3. 共性问题或架构建议\n\n"
+        + "\n\n---\n\n".join(file_summaries)
+    )
+    if len(overview_prompt) > MAX_CHARS_PER_REQUEST:
+        overview_prompt = overview_prompt[:MAX_CHARS_PER_REQUEST] + "\n...(已截断)"
+
+    summary = (
+        _chat(chat_model, overview_prompt)
+        if len(per_file) > 1
+        else per_file[0]["analysis"]
+    )
+
+    return {
+        "summary": summary,
+        "files": per_file,
+        "blocks_count": len(blocks),
+        "files_count": len(per_file),
+        "model_provider": chat_model.config.provider,
+        "model_name": chat_model.config.model,
+    }
+
+
+def analyze_files(
+    paths: list[str],
+    *,
+    provider: str | None = None,
+    api_key: str | None = None,
+    model_name: str | None = None,
+    base_url: str | None = None,
+) -> dict[str, Any]:
+    """从文件路径列表提取代码块并分析。"""
+    blocks = extract_blocks_from_paths(paths)
+    return analyze_blocks(
+        blocks,
+        provider=provider,
+        api_key=api_key,
+        model_name=model_name,
+        base_url=base_url,
+    )
+
+
+def analyze_folder(
+    folder: str,
+    *,
+    provider: str | None = None,
+    api_key: str | None = None,
+    model_name: str | None = None,
+    base_url: str | None = None,
+) -> dict[str, Any]:
+    """扫描目录、提取代码块并分析。"""
+    from devops.scan import scan_code_files
+
+    folder_path = Path(folder).resolve()
+    paths = scan_code_files(str(folder_path))
+    result = analyze_files(
+        paths,
+        provider=provider,
+        api_key=api_key,
+        model_name=model_name,
+        base_url=base_url,
+    )
+    result["folder"] = str(folder_path)
+    result["project_name"] = folder_path.name
+    result["scanned_files_count"] = len(paths)
+    result["generated_at"] = datetime.now(timezone.utc).strftime("%Y-%m-%d %H:%M:%S UTC")
+    return result
+
+
+def render_readme(result: dict[str, Any]) -> str:
+    """将分析结果渲染为 README Markdown 正文。"""
+    project = result.get("project_name") or Path(result.get("folder", ".")).name
+    folder = result.get("folder", "")
+    generated_at = result.get("generated_at", "")
+    scanned = result.get("scanned_files_count", 0)
+    blocks = result.get("blocks_count", 0)
+    files_count = result.get("files_count", 0)
+    summary = result.get("summary", "").strip()
+    per_file: list[dict[str, Any]] = result.get("files", [])
+
+    lines: list[str] = [
+        f"# {project}",
+        "",
+        "> 本文档由代码分析工具自动生成。",
+        "",
+        "## 概览",
+        "",
+        summary or "_暂无分析内容。_",
+        "",
+        "## 统计",
+        "",
+        "| 指标 | 数值 |",
+        "| --- | --- |",
+        f"| 项目路径 | `{folder}` |",
+        f"| 扫描文件数 | {scanned} |",
+        f"| 提取代码块数 | {blocks} |",
+        f"| 已分析文件数 | {files_count} |",
+        f"| 生成时间 | {generated_at} |",
+        f"| 分析模型 | {result.get('model_provider', '')} / {result.get('model_name', '')} |",
+        "",
+    ]
+
+    if per_file:
+        lines.extend(["## 文件分析", ""])
+        for item in per_file:
+            rel = item.get("file_path", "")
+            if folder and rel.startswith(folder):
+                rel = rel[len(folder) :].lstrip("/\\")
+            count = item.get("blocks_count", 0)
+            analysis = (item.get("analysis") or "").strip()
+            lines.append(f"### `{rel}`")
+            lines.append("")
+            lines.append(f"- **代码块数量**: {count}")
+            lines.append("")
+            lines.append(analysis or "_无分析结果。_")
+            lines.append("")
+
+    lines.append("---")
+    lines.append("")
+    lines.append("*Generated by Devops code analyzer*")
+    lines.append("")
+    return "\n".join(lines)
+
+
+def write_project_readme(folder: str, result: dict[str, Any], filename: str = "README.md") -> Path:
+    """将 Markdown 写入目标项目目录下的 README.md。"""
+    folder_path = Path(folder).resolve()
+    output_path = folder_path / filename
+    markdown = render_readme(result)
+    output_path.write_text(markdown, encoding="utf-8")
+    return output_path

devops_analyzer-0.1.0/devops/cli.py

@@ -0,0 +1,190 @@
+"""终端入口：devops <项目路径> | devops config"""
+
+from __future__ import annotations
+
+import argparse
+import sys
+from pathlib import Path
+
+from devops import __version__
+from devops.analysis import analyze_folder, write_project_readme
+from devops.config import config_exists
+from devops.config_cmd import run_config
+
+
+def build_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        prog="devops",
+        description="扫描项目源码，提取代码块，调用大模型分析并生成 README.md",
+    )
+    parser.add_argument(
+        "-V",
+        "--version",
+        action="version",
+        version=f"%(prog)s {__version__}",
+    )
+
+    subparsers = parser.add_subparsers(dest="command")
+
+    config_parser = subparsers.add_parser(
+        "config",
+        help="配置模型 API（首次使用前必须执行）",
+    )
+    config_parser.add_argument(
+        "-s",
+        "--show",
+        action="store_true",
+        help="查看当前配置（API Key 脱敏）",
+    )
+
+    analyze_parser = subparsers.add_parser(
+        "analyze",
+        help="分析项目并生成 README",
+    )
+    analyze_parser.add_argument(
+        "project",
+        nargs="?",
+        help="要分析的项目目录路径",
+    )
+    analyze_parser.add_argument(
+        "-o",
+        "--output",
+        default="README.md",
+        help="输出 Markdown 文件名（默认: README.md）",
+    )
+    analyze_parser.add_argument(
+        "--provider",
+        choices=["openai", "zhipuai", "deepseek", "moonshot"],
+        help="覆盖配置文件中的模型提供商",
+    )
+    analyze_parser.add_argument(
+        "--model",
+        dest="model_name",
+        help="覆盖配置文件中的模型名称",
+    )
+    analyze_parser.add_argument(
+        "--api-key",
+        help="临时指定 API Key（不推荐，会留在 shell 历史）",
+    )
+    analyze_parser.add_argument(
+        "--base-url",
+        help="临时指定 API Base URL（OpenAI 兼容接口）",
+    )
+
+    # 兼容: devops /path/to/project（无子命令）
+    parser.add_argument(
+        "project_legacy",
+        nargs="?",
+        help=argparse.SUPPRESS,
+    )
+    parser.add_argument(
+        "-o",
+        "--output",
+        default="README.md",
+        help=argparse.SUPPRESS,
+    )
+    parser.add_argument(
+        "--provider",
+        choices=["openai", "zhipuai", "deepseek", "moonshot"],
+        help=argparse.SUPPRESS,
+    )
+    parser.add_argument(
+        "--model",
+        dest="model_name",
+        help=argparse.SUPPRESS,
+    )
+    parser.add_argument(
+        "--api-key",
+        help=argparse.SUPPRESS,
+    )
+    parser.add_argument(
+        "--base-url",
+        help=argparse.SUPPRESS,
+    )
+
+    return parser
+
+
+def _run_analyze(args: argparse.Namespace) -> int:
+    folder = getattr(args, "project", None) or getattr(args, "project_legacy", None)
+    if not folder:
+        folder = input("请输入项目文件夹路径: ").strip()
+    if not folder:
+        print("错误: 未提供项目路径", file=sys.stderr)
+        return 1
+
+    if not config_exists() and not args.api_key:
+        print(
+            "错误: 尚未配置模型 API。请先运行:\n\n"
+            "  devops config\n",
+            file=sys.stderr,
+        )
+        return 1
+
+    folder_path = Path(folder).expanduser().resolve()
+    if not folder_path.is_dir():
+        print(f"错误: 不是有效目录: {folder_path}", file=sys.stderr)
+        return 1
+
+    try:
+        from devops.config import load_config
+
+        cfg = load_config(
+            provider=args.provider,
+            api_key=args.api_key,
+            model=args.model_name,
+            base_url=args.base_url,
+        )
+        print(
+            f"正在分析: {folder_path}  "
+            f"[{cfg.provider} / {cfg.model}]"
+        )
+        result = analyze_folder(
+            str(folder_path),
+            provider=args.provider,
+            api_key=args.api_key,
+            model_name=args.model_name,
+            base_url=args.base_url,
+        )
+        output = write_project_readme(
+            str(folder_path), result, filename=args.output
+        )
+        print(f"已生成: {output}")
+        return 0
+    except KeyboardInterrupt:
+        print("\n已取消", file=sys.stderr)
+        return 130
+    except Exception as exc:
+        print(f"错误: {exc}", file=sys.stderr)
+        return 1
+
+
+def main(argv: list[str] | None = None) -> int:
+    argv = list(argv) if argv is not None else sys.argv[1:]
+
+    # devops /path/to/project -> 自动当作 analyze
+    if argv and not argv[0].startswith("-") and argv[0] not in ("config", "analyze"):
+        argv = ["analyze", *argv]
+
+    parser = build_parser()
+    args = parser.parse_args(argv)
+
+    if args.command == "config":
+        extra = ["--show"] if args.show else []
+        return run_config(extra)
+
+    if args.command == "analyze" or args.project_legacy is not None:
+        return _run_analyze(args)
+
+    parser.print_help()
+    print(
+        "\n快速开始:\n"
+        "  1. devops config          # 首次配置 API\n"
+        "  2. devops /path/to/project\n",
+        file=sys.stderr,
+    )
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())