Skip to content

Releases: seanfalling/analyse_github

v0.4.0

Choose a tag to compare

@seanfalling seanfalling released this 25 Oct 02:56

新增功能

报告新增第 5 节 「安装与使用」:分析某个 GitHub 仓库时,自动从其 README 提取安装方式与使用说明,让用户输入仓库链接后即可知道安装后的效果和如何使用。

  • 按一至三级标题智能切块,跳过代码围栏内的 # 注释,子标题自动继承父级分类
  • 覆盖中英文关键词:install/installing/setup/build/clone/quick start/getting started、usage/use/run/examples/cli 及 安装/部署/下载/使用/示例/快速开始 等
  • Markdown 与 HTML 两种格式均支持
  • --compare 对比模式的详细报告同样自动带上该章节
  • README 缺失或无匹配章节时显示占位提示,不报错

兼容性

  • 原有第 1–4 节报告内容保持不变
  • --json 输出仅新增 readme_install / readme_usage 两个字段,旧字段不变

完整改动: v0.3.0...v0.4.0

v0.3.0 首个正式版本

Choose a tag to compare

@seanfalling seanfalling released this 23 Oct 13:21

analyse_github v0.3.0

首个正式版本,包含完整功能。

功能

  • CLI:analyse-github <url> 一条命令生成结构化分析报告(star/license/活跃度/语言构成/健康文件)
  • 多仓库对比:--compare A B [C...] 横向对比任意数量仓库
  • 双格式输出:Markdown / HTML(-o *.html 自动识别,自包含可直接浏览器打开)
  • GitHub Action:手动 / 定时触发,自动产出 MD + HTML 双格式报告
  • AI 工作流:需求模板 + AGENTS.md,适配 Claude Code / Cursor / Codex / Gemini CLI

质量

  • 21 个单元测试,CI 在 push / PR 时自动运行

安装

pip install git+https://github.com/seanfalling/analyse_github.git@v0.3.0