# report

**Repository Path**: ryanvan2000/report

## Basic Information

- **Project Name**: report
- **Description**: 周报自动生成项目
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-03-02
- **Last Updated**: 2026-03-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 周报自动生成项目

每周五下午 6 点自动执行：
1. 按一周时间读取 Git log 信息
2. 将 Git log 提交给 AI，总结本周工作主要内容、完成情况和成果
3. 将总结写入 report.xls 相应位置
4. 将 report.xls 通过邮件发送给您

## 快速开始

### 1. 安装依赖

```bash
pip install -r requirements.txt
```

### 2. 配置

复制 `config.example.env` 为 `.env`，并填写配置：

```bash
copy config.example.env .env
```

编辑 `.env` 文件，必填项：
- **OPENAI_API_KEY**：OpenAI API 密钥（用于 AI 总结）
- **SMTP_SERVER / SMTP_USERNAME / SMTP_PASSWORD**：邮件发送配置
- **EMAIL_FROM / EMAIL_TO**：发件人和收件人邮箱

### 3. 测试运行

```bash
python main.py --now
```

立即执行一次，检查是否正常运行。

### 4. 定时执行

**方式一：Python 定时任务（需保持程序运行）**

```bash
python main.py --schedule
```

程序将持续运行，每周五 18:00 自动执行。

**方式二：Windows 任务计划程序（推荐）**

以管理员身份运行 PowerShell，执行：

```powershell
.\setup_task.ps1
```

## 配置说明

| 配置项 | 说明 | 示例 |
|-------|------|------|
| GIT_REPO_PATH | Git 仓库路径 | e:\Carp\home\Administrator\py\report |
| REPORT_FILE | 报告文件路径 | report.xlsx（保留样式）/ report.xls |
| OPENAI_API_KEY | OpenAI API 密钥 | sk-xxx |
| OPENAI_BASE_URL | API 代理地址（可选） | https://api.openai.com/v1 |
| OPENAI_MODEL | 模型名称 | gpt-4o-mini |
| SMTP_SERVER | SMTP 服务器 | smtp.qq.com |
| SMTP_PORT | SMTP 端口 | 587 |
| SMTP_USERNAME | 邮箱账号 | your@qq.com |
| SMTP_PASSWORD | 邮箱授权码 | xxxxx |
| EMAIL_FROM | 发件人 | your@qq.com |
| EMAIL_TO | 收件人 | your@qq.com |

## 报告结构

报告文件中写入位置（第 5 行）：
- **本周工作内容总结**：Col B (列 2)
- **完成情况及成果**：Col F (列 6)
- **工作中发现的问题和建议**：Col H (列 8)

## 保留 Excel 样式

使用 `.xlsx` 格式可保留原有样式：用 Excel 打开 `report.xls` → 另存为 `report.xlsx` → 在 `.env` 中设置 `REPORT_FILE=.../report.xlsx`。

## 注意事项

1. 当前项目目录需为 Git 仓库，或配置 `GIT_REPO_PATH` 指向您的代码仓库
2. QQ 邮箱需开启 SMTP 并获取授权码
3. 若无法连接 OpenAI，可配置 `OPENAI_BASE_URL` 使用代理