还在为写周报而头疼?还在手动整理Git提交记录?这个开源工具让你彻底解放双手,AI自动生成专业周报!
痛点:写周报的烦恼
作为一名程序员,你是否也有这样的经历:
- 周一早上:老板催着交周报,你却想不起来上周做了什么
- 翻Git记录:一个个查看提交记录,手动整理工作内容
- 绞尽脑汁:如何把技术细节包装成"业务价值"?
- 时间浪费:每次写周报都要花1-2小时,而且质量还不高
据统计,程序员平均每周花在写周报上的时间超过2小时!
解决方案:Git周报生成器
今天要推荐一个开源神器:Git周报生成器(GitCommit2Report)
这是一个基于Python开发的自动化工具,能够:
- ✅ 自动读取Git提交记录 - 无需手动整理
- ✅ AI智能生成周报 - 使用大模型生成专业Markdown格式周报
- ✅ 定时自动执行 - 设置一次,每周自动生成
- ✅ 多项目支持 - 同时管理多个项目的周报
- ✅ 跨平台 - 支持Windows和Linux
核心特性
1. 智能分析Git提交
工具会自动分析指定时间范围内的所有Git提交,包括:
- 提交信息
- 修改的文件
- 代码统计(增删行数)
- 贡献者信息
2. AI生成专业周报
使用硅基流动API(支持DeepSeek-V3等模型),将技术提交记录转换为:
- 工作概述
- 主要功能模块
- 技术亮点
- 代码统计
- 贡献者信息
生成的周报格式专业,直接可以发给老板!
3. 定时任务支持
配置一次,自动运行:
- 支持Cron表达式
- 可设置每周一自动生成
- 支持Windows任务计划程序和Linux systemd
4. 多项目管理
如果你同时维护多个项目,可以:
- 在配置文件中添加多个项目
- 每个项目独立配置时间范围和输出路径
- 一键生成所有项目的周报
快速开始
安装方式一:使用打包版本(推荐)
如果你不想安装Python环境,可以直接下载打包好的可执行文件:
# Windows
下载 git-report.exe
# Linux
下载 git-report 二进制文件
安装方式二:从源码安装
# 1. 克隆项目
git clone https://github.com/Deep-Octopus/GitCommit2Report.git
cd gitcommit2report
# 2. 安装依赖
pip install -r requirements.txt
# 3. 配置
cp config.yaml.example config.yaml
# 编辑 config.yaml,填入API密钥和项目路径
配置文件示例
# 硅基流动API配置
api:
base_url: "https://api.siliconflow.cn/v1"
api_key: "your_api_key_here"
model: "deepseek-ai/DeepSeek-V3"
# 项目配置
projects:
- name: "我的项目"
path: "/path/to/your/project"
enabled: true
schedule: "0 9 * * 1" # 每周一上午9点
time_range:
days: 7
output_path: "./reports"
使用示例
# 手动生成周报
python main.py generate
# 生成指定项目的周报
python main.py generate --project "我的项目"
# 生成过去14天的周报
python main.py generate --project "我的项目" --days 14
# 启动定时任务
python main.py schedule
生成的周报示例
工具会生成类似这样的专业周报:
# 项目周报 - 2025年1月第1周
## 时间范围
2025-01-01 至 2025-01-07
## 工作概述
本周主要完成了用户认证模块的重构和性能优化工作...
## 主要工作内容
### 功能开发
- 实现了OAuth2.0认证流程
- 添加了JWT token刷新机制
- 优化了登录接口响应时间
### 代码优化
- 重构了用户服务层代码
- 优化了数据库查询性能
- 修复了3个已知bug
## 代码统计
- 提交次数: 23
- 修改文件: 45
- 新增代码: +1,234行
- 删除代码: -567行
## 贡献者
- 张三 (15次提交)
- 李四 (8次提交)
实际使用场景
场景1:个人开发者
如果你在维护自己的开源项目,可以:
- 每周自动生成项目周报
- 发布到项目Wiki或README
- 让用户了解项目进展
场景2:团队协作
如果你是团队负责人,可以:
- 为每个项目配置周报生成
- 每周一自动汇总所有项目进展
- 快速了解团队工作状态
场景3:自由职业者
如果你是接外包项目的开发者,可以:
- 自动生成工作周报给客户
- 展示工作量和进度
- 提升专业形象
技术亮点
- Python 3.7+ - 现代Python开发
- Click CLI - 友好的命令行接口
- PyInstaller - 支持打包为独立可执行文件
- Schedule - 灵活的定时任务调度
- GitPython - 强大的Git操作库
- 硅基流动API - 支持多种大模型
项目地址
GitHub: github.com/Deep-Octopu…
⭐ 如果觉得有用,欢迎Star支持!
为什么选择这个工具?
1. 完全开源
- MIT许可证,可自由使用和修改
- 代码透明,安全可靠
2. 易于使用
- 配置简单,5分钟上手
- 支持打包版本,无需Python环境
3. 功能完善
- 支持多项目
- 支持定时任务
- 支持自定义时间范围
4. 持续更新
- 活跃维护
- 欢迎贡献代码和Issue
常见问题
Q: 需要什么API? A: 使用硅基流动API,支持最新的Pro/zai-org/GLM-5等模型,价格便宜,效果优秀。
Q: 支持哪些Git平台? A: 支持所有标准Git仓库,包括GitHub、GitLab、Gitee、本地仓库等。
Q: 生成的周报质量如何? A: 使用大模型生成,质量远超手动编写,而且格式统一专业。
Q: 可以自定义周报格式吗? A: 可以,支持修改模板和提示词,完全可定制。
总结
写周报是每个程序员的痛点,但有了这个工具,你可以:
- ⏰ 节省时间 - 每周节省2小时
- 📊 提升质量 - AI生成专业周报
- 🎯 自动化 - 设置一次,永久使用
- 🚀 多项目 - 同时管理多个项目
不要再为周报而烦恼了! 现在就试试这个工具,让你的周报写作变得轻松愉快。
项目地址: github.com/Deep-Octopu…
如果觉得有用,请给个Star⭐,让更多人看到!