# sync_demo

**Repository Path**: on88888/sync_demo

## Basic Information

- **Project Name**: sync_demo
- **Description**: sync_demo......
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-20
- **Last Updated**: 2026-05-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 工具简介
这是一个用于自动化将当前目录中的文件提交到 Gitee 远程仓库的工具，Python 脚本 (git-auto-push.py) 支持跨平台使用（Windows/Linux/macOS）。通过环境变量文件 (.env) 动态读取参数，支持初始化 Git 仓库、创建远程仓库（如果不存在）、自动提交更改并推送到远程仓库。

---

## 目录结构
.
├── git-auto-push.py       # Python 主脚本，跨平台自动提交工具
├── .env                     # 配置文件（需自行创建，存储敏感信息）
├── .env.example             # 配置文件示例（可提交到仓库）
├── .gitignore               # Git 忽略文件配置
└── README.md                # 项目说明文档

---

## 功能特点
- 环境变量配置：从 .env 文件中读取 Gitee 用户名、仓库名称和访问令牌，更安全。
- 跨平台支持：基于 Python 实现，支持 Windows、Linux 和 macOS 系统。
- 自动初始化：如果当前目录没有 Git 仓库，会自动初始化并关联远程仓库。
- 远程仓库创建：如果远程仓库不存在，会调用 Gitee API 创建私有仓库。
- 支持Token协议：支持 HTTPS + Access Token 认证方式。
- 自动提交与推送：将当前目录的所有更改添加到暂存区，并自动生成带有时间戳的提交信息。
- 倒计时退出：执行完成后自动倒计时 10 秒退出，方便查看执行结果。

---

## 使用说明

### 1. 准备工作

#### 安装环境
- 安装 Python 3.6+
- 安装 Git 工具

#### 获取 Gitee 访问令牌
访问 https://gitee.com/profile/personal_access_tokens 进入到以下界面

![示例1](./img/6f2a600330b14d69ad8cc6dae1e7c3e9.png)


### 2. 配置文件

复制 .env.example 为 .env 并填写真实信息：

```sh
# Gitee 用户名（必填）
GITEE_USER=your_username
# 仓库名称（必填）
REPO_NAME=your_repo_name
# Gitee 访问令牌（必填）
# 在 https://gitee.com/profile/personal_access_tokens 生成
# 需要勾选 projects 权限
ACCESS_TOKEN=your_access_token_here
```

![示例2](./img/c1b338919aa94c43981e659d949079da.png)

### 3. 使用方法

```
以下方式二选一
1.安装 Python 依赖库：pip install requests
	执行脚本 -> git-auto-push.py
	
2.双击exe程序 -> git-auto-push.exe
```

脚本将自动完成以下操作：
1. 检查当前目录是否已有 Git 仓库，若无则初始化
2. 关联远程仓库（如果尚未关联）
3. 如果远程仓库不存在，则通过 Gitee API 创建新仓库
4. 将当前目录的所有更改添加到暂存区
5. 生成带时间戳的提交信息并提交
6. 推送到远程仓库
7. 倒计时 10 秒后自动退出

---

## 注意事项
1. 安全：.env 文件包含敏感信息，请勿提交到公开仓库，务必添加到 .gitignore
2. 权限：确保 Gitee 访问令牌具有 projects 权限
3. 网络：脚本需要稳定的网络连接以调用 Gitee API 和推送代码

---

## .gitignore 配置示例
```sh
# 配置文件（包含敏感信息）
.env

# Python
__pycache__/
*.py[cod]
*.pyo
.venv

# IDE 配置
.vscode
.idea
```