brianpelow/TechDebtLedger

# TechDebtLedger    ## 概述 `TechDebtLedger` 会扫描您的代码库，并生成一份优先级明确、由数据驱动的 技术债务偿还路线图。它能识别复杂度热点、带有注解的债务 项（TODO/FIXME/HACK）、过时的依赖项以及重复代码密度 — 然后根据估算的修复价值对它们进行排名。 专为受监管的金融服务和制造业领域的工程领导者打造，在这些领域中，未加管理的技术债务会引发审计风险、拖慢交付速度，并扩大事故的影响范围。 ## API 端点 | 端点 | 描述 | |----------|-------------| | `GET /health` | 服务健康检查 | | `POST /scan` | 扫描代码库并返回债务清单 | | `GET /scan/{scan_id}/summary` | 获取已完成扫描的债务摘要 | | `GET /scan/{scan_id}/roadmap` | 获取确定优先级的偿还路线图 | | `GET /scan/{scan_id}/hotspots` | 获取排名靠前的复杂度热点 | | `GET /scan/{scan_id}/todos` | 获取所有带有注解的债务项 | | `GET /scan/{scan_id}/narrative` | AI 生成的债务陈述报告 | ## 扫描的债务类别 | 类别 | 信号 | 优先级权重 | |----------|--------|-----------------| | 复杂度热点 | 圈复杂度 > 阈值 | 高 | | 带注解的债务 | TODO/FIXME/HACK/XXX 注释 | 中 | | 依赖项过时 | 发布时间超过 12 个月的软件包 | 中 | | 代码重复 | 重复代码块 > 10 行 | 低 | ## 快速开始 ``` pip install TechDebtLedger tech-debt-ledger # 位于 http://localhost:8000 的 API # 扫描 repo curl -X POST http://localhost:8000/scan \ -H "Content-Type: application/json" \ -d "{\"repo_path\": \"./my-service\", \"name\": \"my-service\"}" ``` ## 配置 | 变量 | 描述 | 必填 | |----------|-------------|----------| | `ANTHROPIC_API_KEY` | 用于生成 AI 债务陈述报告 | 否 | | `DEBT_INDUSTRY` | 行业背景 | 否 | ## 贡献 请参阅 [CONTRIBUTING.md](CONTRIBUTING.md)。 ## 许可证 Apache 2.0 — 请参阅 [LICENSE](LICENSE)。

标签：Python, SOC Prime, Web API, 幻觉检测, 开发工具, 技术债务, 无后门, 逆向工具, 错误基检测, 静态代码分析