GitHunt
ZH

Git 分支同步监控工具

一个基于 Textual TUI 框架的 Git 分支同步监控工具,用于实时监控两个分支之间的同步状态。

功能特点

  • 实时监控指定的 Git 分支同步状态(每10秒检查一次)
  • 自动检测分支更新并发送应用内通知提醒
  • 支持手动触发分支同步
  • 自动保存配置信息
  • 详细的操作日志记录
  • 友好的终端用户界面(TUI)

安装要求

  • Python 3.7+
  • Git

安装步骤

  1. 克隆仓库:
git clone https://github.com/ZhangBohan/moss.git
cd moss
  1. 安装依赖:
pip install -r requirements.txt

使用方法

  1. 启动程序:
python src/git_sync_monitor.py
  1. 配置监控信息:

    • Git 仓库路径:输入要监控的 Git 仓库本地路径
    • 监听分支:输入需要监听的源分支名(如 develop)
    • 目标分支:输入需要同步的目标分支名(如 master)
  2. 操作说明:

    • 点击"开始监控"按钮启动监控
    • 当检测到分支需要同步时,会显示通知提醒
    • 点击"同步分支"按钮执行分支同步
    • 点击"停止监控"按钮停止监控

配置文件

程序会在用户主目录下创建 .moss 文件夹,包含:

  • config.json:保存最近使用的配置信息

    • 仓库路径
    • 监听分支名
    • 目标分支名
  • app.log:操作日志文件

    • 使用循环日志方式记录
    • 单个日志文件最大 1MB
    • 保留最近 3 个备份文件

注意事项

  1. 权限要求:

    • 确保对目标 Git 仓库有足够的读写权限
    • 确保有权限访问和修改配置目录(~/.moss)
  2. 使用建议:

    • 建议在稳定的网络环境下使用
    • 同步操作前确保本地代码已提交或存储
    • 定期检查日志文件了解程序运行状态

开发相关

  • 基于 Textual 框架开发,支持终端界面交互
  • 使用 GitPython 进行 Git 操作
  • 采用响应式编程模式
  • 支持配置持久化和日志记录

许可证

MIT License

贡献

欢迎提交 Issue 和 Pull Request!


这个 README.md 文件包含了所有必要的信息,包括:
1. 项目介绍
2. 功能列表
3. 安装说明
4. 使用方法
5. 配置说明
6. 注意事项
7. 开发信息
8. 许可和贡献说明

所有代码块都使用了正确的语法高亮标记,并且格式保持一致。您可以根据需要进一步补充或修改内容。

Languages

Python96.1%CSS3.9%
Created January 21, 2025
Updated January 21, 2025