# Gitmm

**Repository Path**: osdepk/gitmm

## Basic Information

- **Project Name**: Gitmm
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-08
- **Last Updated**: 2026-07-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Gitmm

> 图形化 Git 桌面客户端，支持 **Gitee + GitHub** 双平台。

Gitmm 是一款运行在 Windows 上的纯图形化 Git 工具，基于 **PyQt5 + PyQt-Fluent-Widgets** 构建，底层通过 `subprocess` 调用系统 Git 命令，完全免命令行。

支持 Gitee / GitHub 双平台的 PAT 令牌登录、远程仓库操作、远程文件浏览、提交历史查看、动态菜单与更新检查等功能。

[English Version](README_EN.md)

![License](https://img.shields.io/badge/license-MIT-blue)
![Python](https://img.shields.io/badge/python-3.10%2B-blue)
![Platform](https://img.shields.io/badge/platform-Windows%2010%2F11-blue)

## 特性

- 🟢 **零命令行** — 全部操作通过图形界面完成
- 🟠 **Gitee 集成** — PAT 令牌登录，远程仓库操作
- ⚫ **GitHub 集成** — PAT 令牌登录，支持 Fine-grained token
- 🔑 **令牌管理** — 加密存储到 Windows 凭据管理器（keyring）
- 👤 **提交者身份** — 分平台配置 name + email，支持全局默认
- 📁 **远程文件浏览** — 浏览远程仓库文件树，按需拉取
- 🌐 **网络检测** — 启动时检测 GitHub / Gitee 连通性
- 🎨 **主题切换** — 浅色 / 深色 / 自动 三模式
- 🔄 **更新检查** — 对接后台网站，自动检查新版本

## 运行环境

- Windows 10 1809+ / Windows 11
- Python 3.10+
- Git for Windows，或让 Gitmm 自动使用内置 Git

## 快速开始

### 1. 克隆仓库

```powershell
git clone https://github.com/osdepk/gitmm.git
cd gitmm
```

### 2. 创建并激活虚拟环境

```powershell
python -m venv venv
.\venv\Scripts\Activate.ps1
```

### 3. 安装依赖

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

若需要进行开发（测试、代码检查），可额外安装开发依赖：

```powershell
pip install -e ".[dev]"
```

### 4. 准备 Git

Gitmm 优先使用系统 Git。在命令行执行以下命令检查是否已安装：

```powershell
git --version
```

- 如果已输出 Git 版本号，直接跳到下一步。
- 如果未安装，可运行内置 Git 下载脚本：

```powershell
python scripts/setup_git.py
```

或者手动下载安装 [Git for Windows](https://git-scm.com/download/win)。

### 5. 启动程序

```powershell
python main.py
```

首次启动后，配置会保存在 `C:\Users\<用户名>\.gitmm\config.json`，平台 PAT 令牌会存储到 Windows 凭据管理器。

## 项目结构

```
Gitmm/
├── main.py                 # 程序入口
├── pyproject.toml          # 项目配置与依赖
├── requirements.txt        # 运行时依赖
├── app/                    # 应用级代码（主窗口、配置、主题）
├── core/                   # 核心逻辑
│   ├── backend/            # 后台 API 客户端（更新、菜单、用户上报）
│   ├── credential/         # Windows 凭据管理（keyring）
│   ├── git_engine/         # Git 命令封装与内置 Git 管理
│   └── platform/           # Gitee / GitHub 平台 API 抽象
├── ui/                     # 界面层（页面、组件、对话框、工作线程）
├── scripts/                # 辅助脚本（如下载内置 Git）
├── build/                  # PyInstaller / Inno Setup 构建配置
└── tests/                  # 测试
```

## 使用说明

1. **打开仓库**：点击左侧导航栏的「仓库」页，选择本地仓库文件夹，或直接克隆远程仓库。
2. **配置令牌**：在仓库页的「提交者 / 令牌」区域填写 Gitee / GitHub 的 PAT 令牌，程序会自动存入 Windows 凭据管理器。
3. **拉取 / 推送**：配置好令牌后，可一键拉取、推送，或浏览远程文件树按需拉取。
4. **主题切换**：点击左下角的主题按钮可在浅色 / 深色之间切换。

## 打包成安装程序

### 1. 安装打包依赖

```powershell
pip install -e ".[build]"
```

### 2. PyInstaller 打包

```powershell
pyinstaller --clean build/Gitmm.spec
```

输出目录：`dist/Gitmm/`

### 3. Inno Setup 生成安装包

确保已安装 [Inno Setup 7](https://jrsoftware.org/isinfo.php)，然后执行：

```powershell
& "C:\Program Files\Inno Setup 7\ISCC.exe" build/installer.iss
```

输出文件：`build/output/Gitmm-Setup-1.5.0.exe`

## 运行测试

```powershell
pytest
```

## 配置与数据位置

| 数据 | 位置 | 说明 |
|------|------|------|
| 应用配置 | `~/.gitmm/config.json` | 主题、最近打开、提交者元数据等 |
| 平台令牌 | Windows 凭据管理器 | keyring 加密存储，不写入配置文件 |
| 菜单缓存 | `~/.gitmm/menu_cache.json` | 后台动态菜单离线缓存 |

## 文档

- [PLANNING.md](PLANNING.md) — 项目架构、模块设计与已实现功能
- [README_EN.md](README_EN.md) — English version

## 协议

MIT © 2026 osdepk