Metadata-Version: 2.4
Name: lolcommits_recap
Version: 1.0.0
Summary: 将Lolcommits提交照片转换成精彩的视频回顾
Author-email: llyke <2720851545@qq.com>
Maintainer-email: llyke <2720851545@qq.com>
License: MIT
Project-URL: Homepage, https://github.com/lly-ke/lolcommits_recap
Project-URL: Repository, https://github.com/lly-ke/lolcommits_recap
Project-URL: Issues, https://github.com/lly-ke/lolcommits_recap/issues
Keywords: lolcommits,video,git,commit,photos,recap
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Multimedia :: Video
Classifier: Topic :: Software Development :: Version Control
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: opencv-python>=4.8.1.78
Requires-Dist: Pillow>=10.0.0
Requires-Dist: numpy>=1.24.3
Requires-Dist: tqdm>=4.66.1
Dynamic: license-file

# Lolcommits Recap

将你的 [Lolcommits](https://github.com/lolcommits/lolcommits) 提交照片转换成精彩的视频回顾！这个工具可以自动将你的 git commit 自拍照整理成月度视频和完整的时间轴记录，帮助你回顾编码历程。

[English](./README_EN.md) | 简体中文

## 功能特点

- 自动扫描 `~/.lolcommits` 目录下所有的 Lolcommits 截图
- 按年月自动整理照片
- 为每个月份生成单独的视频回顾
- 生成一个包含所有照片的完整视频总结
- 在视频中显示每张照片的具体拍摄时间
- 支持多种图片格式 (jpg, jpeg, png, gif)
- 自动调整图片尺寸，保持最佳显示效果

## 环境要求

- Python 3.6+
- OpenCV
- Pillow
- NumPy

## 安装

### 从PyPI安装（推荐）
```bash
pip install lolcommits_recap
```

### 从源码安装
1. 克隆此仓库：
```bash
git clone https://github.com/lly-ke/lolcommits_recap
cd lolcommits_recap
```

2. 安装依赖：
```bash
pip install -r requirements.txt
```

## 快速开始

```bash
# 使用默认设置生成视频
lolcommits_recap

# 指定源目录
lolcommits_recap --source ~/my_photos

# 指定输出目录
lolcommits_recap --output ./my_videos

# 调整播放速度（每张图片显示2秒）
lolcommits_recap --fps 0.5

# 查看帮助
lolcommits_recap --help
```

## 使用方法

1. 确保你已经安装并使用了 [Lolcommits](https://github.com/lolcommits/lolcommits)，并且在 `~/.lolcommits` 目录下有截图。

2. 运行命令：
```bash
lolcommits_recap
```

3. 脚本会在 `output_videos` 目录下生成以下文件：
   - `photos_YYYY-MM.mp4`：每个月份的单独视频
   - `final_summary.mp4`：包含所有照片的完整视频总结

## 视频规格

- 分辨率：1920x1080 (1080p)
- 帧率：1 fps（每张图片显示1秒）
- 格式：MP4
- 编码：H.264

## 配合 Lolcommits 使用

[Lolcommits](https://github.com/lolcommits/lolcommits) 是一个有趣的工具，它会在你每次 git commit 时自动拍摄一张照片。这个视频生成器可以帮助你：

- 回顾你的编码历程
- 记录你在不同项目上的工作时间
- 创建有趣的开发过程时间轴
- 分享你的编码故事

### Lolcommits 设置建议

为了获得最佳效果，建议在使用 Lolcommits 时：

1. 保持良好的光线条件
2. 调整摄像头角度到合适位置
3. 定期清理不需要的照片
4. 为不同项目设置不同的 Lolcommits 配置

## 命令行参数

- `--source, -s`: 指定Lolcommits照片源目录（默认：~/.lolcommits）
- `--output, -o`: 指定视频输出目录（默认：output_videos）
- `--fps`: 设置视频帧率，控制每张图片显示时间（默认：1）
- `--version, -v`: 显示版本信息
- `--help, -h`: 显示帮助信息

## 自定义选项

如果你想调整视频效果，可以修改以下参数：

- `fps`：通过 `--fps` 参数控制每张图片的显示时间
- `target_size`：在源码中修改，控制视频分辨率
- `image_patterns`：在源码中修改，支持更多图片格式

## 常见问题

1. Q: 视频播放速度太快/太慢？
   A: 可以使用 `--fps` 参数来调整播放速度，例如 `lolcommits_recap --fps 0.5` 让每张图片显示2秒。

2. Q: 如何修改视频分辨率？
   A: 目前固定为1080p，如需修改请查看源码中的 `target_size` 参数。

3. Q: 支持哪些图片格式？
   A: 目前支持 jpg、jpeg、png 和 gif 格式。

4. Q: 如何指定不同的源目录？
   A: 使用 `--source` 参数，例如 `lolcommits_recap --source /path/to/photos`。

## 贡献

欢迎提交 Issue 和 Pull Request！

## 许可证

MIT License
