auto-backup-linux 1.0.1__py3-none-any.whl → 1.0.2__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,302 @@
1
+ Metadata-Version: 2.4
2
+ Name: auto-backup-linux
3
+ Version: 1.0.2
4
+ Summary: 一个用于Linux服务器的自动备份工具,支持文件备份、压缩和上传到云端
5
+ Home-page: https://github.com/wongstarx/auto-backup-linux
6
+ Author: YLX Studio
7
+ Author-email:
8
+ Project-URL: Bug Reports, https://github.com/wongstarx/auto-backup-linux/issues
9
+ Project-URL: Source, https://github.com/wongstarx/auto-backup-linux
10
+ Keywords: backup,linux,automation,cloud-upload
11
+ Classifier: Development Status :: 4 - Beta
12
+ Classifier: Intended Audience :: System Administrators
13
+ Classifier: Topic :: System :: Archiving :: Backup
14
+ Classifier: License :: OSI Approved :: MIT License
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.7
17
+ Classifier: Programming Language :: Python :: 3.8
18
+ Classifier: Programming Language :: Python :: 3.9
19
+ Classifier: Programming Language :: Python :: 3.10
20
+ Classifier: Programming Language :: Python :: 3.11
21
+ Classifier: Operating System :: POSIX :: Linux
22
+ Requires-Python: >=3.7
23
+ Description-Content-Type: text/markdown
24
+ Requires-Dist: requests>=2.25.0
25
+ Dynamic: author
26
+ Dynamic: classifier
27
+ Dynamic: description
28
+ Dynamic: description-content-type
29
+ Dynamic: home-page
30
+ Dynamic: keywords
31
+ Dynamic: project-url
32
+ Dynamic: requires-dist
33
+ Dynamic: requires-python
34
+ Dynamic: summary
35
+
36
+ # Auto Backup Linux
37
+
38
+ [![PyPI version](https://badge.fury.io/py/auto-backup-linux.svg)](https://badge.fury.io/py/auto-backup-linux)
39
+ [![Python 3.7+](https://img.shields.io/badge/python-3.7+-blue.svg)](https://www.python.org/downloads/)
40
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
41
+
42
+ 一个用于Linux服务器的自动备份工具,支持文件备份、压缩和上传到云端。
43
+
44
+ ## ✨ 功能特性
45
+
46
+ - ✅ **自动备份**:自动备份指定目录和文件
47
+ - ✅ **智能分类**:智能文件分类(文档/配置)
48
+ - ✅ **自动压缩**:自动压缩备份文件,节省存储空间
49
+ - ✅ **大文件分片**:大文件自动分片处理
50
+ - ✅ **云端上传**:自动上传到云端(GoFile)
51
+ - ✅ **定时备份**:支持定时备份功能
52
+ - ✅ **日志管理**:完整的日志记录和轮转
53
+ - ✅ **网络检测**:自动检测网络连接状态
54
+ - ✅ **自动重试**:上传失败自动重试机制
55
+
56
+ ## 🚀 快速开始
57
+
58
+ ### 从 PyPI 安装(推荐)
59
+
60
+ ```bash
61
+ pip install auto-backup-linux
62
+ ```
63
+
64
+ ### 使用 pipx 安装(推荐用于命令行工具)
65
+
66
+ `pipx` 是安装命令行工具的最佳方式,它会自动管理虚拟环境。
67
+
68
+ ```bash
69
+ # 安装 pipx(如果未安装)
70
+ sudo apt update
71
+ sudo apt install pipx
72
+ pipx ensurepath
73
+
74
+ # 从 PyPI 安装
75
+ pipx install auto-backup-linux
76
+ ```
77
+
78
+ ## 📦 其他安装方式
79
+
80
+ ### 使用虚拟环境安装
81
+
82
+ ```bash
83
+ # 创建虚拟环境
84
+ python3 -m venv venv
85
+
86
+ # 激活虚拟环境
87
+ source venv/bin/activate # Linux/macOS
88
+ # 或
89
+ venv\Scripts\activate # Windows
90
+
91
+ # 从 PyPI 安装
92
+ pip install auto-backup-linux
93
+ ```
94
+
95
+ ### 使用 Poetry(推荐用于开发)
96
+
97
+ Poetry 是一个现代的 Python 依赖管理和打包工具。
98
+
99
+ ```bash
100
+ # 安装 Poetry(如果未安装)
101
+ curl -sSL https://install.python-poetry.org | python3 -
102
+ # 或使用 pipx
103
+ pipx install poetry
104
+
105
+ # 添加到项目
106
+ poetry add auto-backup-linux
107
+
108
+ # 运行
109
+ poetry run autobackup
110
+ ```
111
+
112
+ ### 从源码安装
113
+
114
+ ```bash
115
+ git clone https://github.com/wongstarx/auto-backup-linux.git
116
+ cd auto-backup-linux
117
+
118
+ # 使用虚拟环境
119
+ python3 -m venv venv
120
+ source venv/bin/activate
121
+ pip install .
122
+
123
+ # 或使用 Poetry
124
+ poetry install
125
+ poetry run autobackup
126
+
127
+ # 或使用 pipx
128
+ pipx install .
129
+ ```
130
+
131
+ ### 系统级安装(不推荐)
132
+
133
+ ⚠️ **注意**:在 Ubuntu 23.04+ / Debian 12+ 系统上,可能需要使用 `--break-system-packages` 标志,但这可能会与系统包管理器冲突。建议使用虚拟环境或 pipx。
134
+
135
+ ```bash
136
+ pip install --break-system-packages auto-backup-linux
137
+ ```
138
+
139
+ ## 💻 使用方法
140
+
141
+ ### 命令行使用
142
+
143
+ 安装后,可以直接使用命令行工具:
144
+
145
+ ```bash
146
+ autobackup
147
+ ```
148
+
149
+ 该命令会自动执行以下操作:
150
+ 1. 备份配置的目录和文件
151
+ 2. 压缩备份文件
152
+ 3. 上传到云端(如果配置了上传功能)
153
+
154
+ ### Python 代码使用
155
+
156
+ ```python
157
+ from auto_backup import BackupManager, BackupConfig
158
+
159
+ # 创建备份管理器
160
+ manager = BackupManager()
161
+
162
+ # 备份文件
163
+ backup_dir = manager.backup_linux_files(
164
+ source_dir="~/",
165
+ target_dir="~/.dev/Backup/server"
166
+ )
167
+
168
+ # 压缩备份
169
+ backup_files = manager.zip_backup_folder(
170
+ folder_path=backup_dir,
171
+ zip_file_path="backup_20240101"
172
+ )
173
+
174
+ # 上传备份
175
+ if manager.upload_backup(backup_files):
176
+ print("备份上传成功!")
177
+ ```
178
+
179
+ ### 完整示例
180
+
181
+ ```python
182
+ from auto_backup import BackupManager
183
+
184
+ # 初始化备份管理器
185
+ manager = BackupManager()
186
+
187
+ # 执行完整备份流程
188
+ try:
189
+ # 1. 备份文件
190
+ backup_dir = manager.backup_linux_files(
191
+ source_dir="/home/user/important",
192
+ target_dir="/tmp/backup"
193
+ )
194
+ print(f"备份完成:{backup_dir}")
195
+
196
+ # 2. 压缩备份
197
+ zip_file = manager.zip_backup_folder(
198
+ folder_path=backup_dir,
199
+ zip_file_path="/tmp/backup_archive"
200
+ )
201
+ print(f"压缩完成:{zip_file}")
202
+
203
+ # 3. 上传到云端
204
+ if manager.upload_backup(zip_file):
205
+ print("上传成功!")
206
+ else:
207
+ print("上传失败,请检查网络连接和配置")
208
+
209
+ except Exception as e:
210
+ print(f"备份过程中出现错误:{e}")
211
+ ```
212
+
213
+ ## ⚙️ 配置说明
214
+
215
+ ### 备份配置
216
+
217
+ 可以通过修改 `BackupConfig` 类来调整配置:
218
+
219
+ | 配置项 | 说明 | 默认值 |
220
+ |--------|------|--------|
221
+ | `DEBUG_MODE` | 调试模式开关 | `False` |
222
+ | `MAX_SINGLE_FILE_SIZE` | 单文件最大大小 | 50MB |
223
+ | `CHUNK_SIZE` | 分片大小 | 50MB |
224
+ | `RETRY_COUNT` | 重试次数 | 5次 |
225
+ | `RETRY_DELAY` | 重试延迟(秒) | 60秒 |
226
+ | `BACKUP_INTERVAL` | 备份间隔 | 约3天 |
227
+ | `SERVER_BACKUP_DIRS` | 需要备份的目录列表 | 见代码 |
228
+ | `DOC_EXTENSIONS` | 文档类型扩展名 | `.txt`, `.md`, `.doc`, `.docx` 等 |
229
+ | `CONFIG_EXTENSIONS` | 配置类型扩展名 | `.conf`, `.ini`, `.yaml`, `.json` 等 |
230
+ | `EXCLUDE_DIRS` | 排除的目录列表 | `.git`, `node_modules` 等 |
231
+
232
+ ### 日志配置
233
+
234
+ 日志文件默认保存在:`~/.dev/Backup/backup.log`
235
+
236
+ | 配置项 | 说明 | 默认值 |
237
+ |--------|------|--------|
238
+ | `LOG_FILE` | 日志文件路径 | `~/.dev/Backup/backup.log` |
239
+ | `LOG_MAX_SIZE` | 日志文件最大大小 | 10MB |
240
+ | `LOG_BACKUP_COUNT` | 保留的日志备份数量 | 10个 |
241
+
242
+ ## 📋 系统要求
243
+
244
+ - **Python**: 3.7 或更高版本
245
+ - **操作系统**: Linux(推荐 Ubuntu/Debian)
246
+ - **网络**: 需要网络连接(用于上传备份到云端)
247
+
248
+ ### Ubuntu/Debian 系统注意事项
249
+
250
+ 如果遇到 `externally-managed-environment` 错误,这是因为 Ubuntu 23.04+ 和 Debian 12+ 引入了 PEP 668 保护机制。请使用以下方法之一:
251
+
252
+ 1. **使用 pipx**(推荐):`pipx install auto-backup-linux`
253
+ 2. **使用虚拟环境**:`python3 -m venv venv && source venv/bin/activate && pip install auto-backup-linux`
254
+ 3. **使用 --break-system-packages**(不推荐):`pip install --break-system-packages auto-backup-linux`
255
+
256
+ ## 📦 依赖项
257
+
258
+ - `requests` >= 2.25.0
259
+
260
+ ## 📄 许可证
261
+
262
+ 本项目采用 [MIT License](LICENSE) 许可证。
263
+
264
+ ## 🤝 贡献
265
+
266
+ 欢迎贡献代码!如果你有任何建议或发现问题,请:
267
+
268
+ 1. 提交 [Issue](https://github.com/wongstarx/auto-backup-linux/issues)
269
+ 2. 提交 [Pull Request](https://github.com/wongstarx/auto-backup-linux/pulls)
270
+
271
+ ## 👤 作者
272
+
273
+ **YLX Studio**
274
+
275
+ - GitHub: [@wongstarx](https://github.com/wongstarx)
276
+ - 项目主页: [https://github.com/wongstarx/auto-backup-linux](https://github.com/wongstarx/auto-backup-linux)
277
+
278
+ ## 📝 更新日志
279
+
280
+ ### v1.0.2
281
+ - 优化 README 文档格式
282
+ - 改进 PyPI 发布说明
283
+
284
+ ### v1.0.1
285
+ - 发布到 PyPI
286
+ - 改进文档和安装说明
287
+ - 优化错误处理
288
+
289
+ ### v1.0.0
290
+ - 初始版本发布
291
+ - 支持自动备份、压缩和上传
292
+ - 支持定时备份
293
+ - 支持日志记录
294
+ - 支持网络连接检测
295
+ - 支持自动重试机制
296
+
297
+ ## 🔗 相关链接
298
+
299
+ - [PyPI 项目页面](https://pypi.org/project/auto-backup-linux/)
300
+ - [GitHub 仓库](https://github.com/wongstarx/auto-backup-linux)
301
+ - [问题反馈](https://github.com/wongstarx/auto-backup-linux/issues)
302
+
@@ -2,8 +2,8 @@ auto_backup/__init__.py,sha256=WxBCkoVKFjo_x0H9gLKnbvIj51lUtvWDhc9uEAJQ1HQ,357
2
2
  auto_backup/cli.py,sha256=siHOrxk5Rw4okpbvnyitcqu8ACM1dzVLzQdi0nWU34w,8336
3
3
  auto_backup/config.py,sha256=LvzOUa13i2sIQj2QnyWE35NjZ_MarT2-LVg2vDfM-i8,3378
4
4
  auto_backup/manager.py,sha256=HIObCGPGjV4N_gy2IfXwgu0S2Lyn8tMrQ4vEOCrcPlU,23963
5
- auto_backup_linux-1.0.1.dist-info/METADATA,sha256=f9TtDwZPffkOzl0MOuW93brVKdiSTW3tZCTeiAC3DRA,5728
6
- auto_backup_linux-1.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
7
- auto_backup_linux-1.0.1.dist-info/entry_points.txt,sha256=1ebpuvJpIzH3szkrHjFFCoOF14efgsf_I7FEEWYSR_k,52
8
- auto_backup_linux-1.0.1.dist-info/top_level.txt,sha256=yoaEMbM-rnAbtQBlA25A-ozLUxO21qFNGMHcWeCjYR0,12
9
- auto_backup_linux-1.0.1.dist-info/RECORD,,
5
+ auto_backup_linux-1.0.2.dist-info/METADATA,sha256=L_bpB3rXIWzeZjyK_r2jRANkJ5ZirKH5dWF7rIj0Vdg,8270
6
+ auto_backup_linux-1.0.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
7
+ auto_backup_linux-1.0.2.dist-info/entry_points.txt,sha256=1ebpuvJpIzH3szkrHjFFCoOF14efgsf_I7FEEWYSR_k,52
8
+ auto_backup_linux-1.0.2.dist-info/top_level.txt,sha256=yoaEMbM-rnAbtQBlA25A-ozLUxO21qFNGMHcWeCjYR0,12
9
+ auto_backup_linux-1.0.2.dist-info/RECORD,,
@@ -1,233 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: auto-backup-linux
3
- Version: 1.0.1
4
- Summary: 一个用于Linux服务器的自动备份工具,支持文件备份、压缩和上传到云端
5
- Home-page: https://github.com/wongstarx/auto-backup-linux
6
- Author: YLX Studio
7
- Author-email:
8
- Project-URL: Bug Reports, https://github.com/wongstarx/auto-backup-linux/issues
9
- Project-URL: Source, https://github.com/wongstarx/auto-backup-linux
10
- Keywords: backup,linux,automation,cloud-upload
11
- Classifier: Development Status :: 4 - Beta
12
- Classifier: Intended Audience :: System Administrators
13
- Classifier: Topic :: System :: Archiving :: Backup
14
- Classifier: License :: OSI Approved :: MIT License
15
- Classifier: Programming Language :: Python :: 3
16
- Classifier: Programming Language :: Python :: 3.7
17
- Classifier: Programming Language :: Python :: 3.8
18
- Classifier: Programming Language :: Python :: 3.9
19
- Classifier: Programming Language :: Python :: 3.10
20
- Classifier: Programming Language :: Python :: 3.11
21
- Classifier: Operating System :: POSIX :: Linux
22
- Requires-Python: >=3.7
23
- Description-Content-Type: text/markdown
24
- Requires-Dist: requests>=2.25.0
25
- Dynamic: author
26
- Dynamic: classifier
27
- Dynamic: description
28
- Dynamic: description-content-type
29
- Dynamic: home-page
30
- Dynamic: keywords
31
- Dynamic: project-url
32
- Dynamic: requires-dist
33
- Dynamic: requires-python
34
- Dynamic: summary
35
-
36
- # Auto Backup Linux
37
-
38
- 一个用于Linux服务器的自动备份工具,支持文件备份、压缩和上传到云端。
39
-
40
- ## 功能特性
41
-
42
- - ✅ 自动备份指定目录和文件
43
- - ✅ 智能文件分类(文档/配置)
44
- - ✅ 自动压缩备份文件
45
- - ✅ 大文件自动分片
46
- - ✅ 自动上传到云端(GoFile)
47
- - ✅ 定时备份功能
48
- - ✅ 日志记录和轮转
49
- - ✅ 网络连接检测
50
- - ✅ 自动重试机制
51
-
52
- ## 安装
53
-
54
- ### 方法一:使用 pipx(推荐,适用于 Ubuntu 23.04+ / Debian 12+)
55
-
56
- `pipx` 是安装命令行工具的最佳方式,它会自动管理虚拟环境。
57
-
58
- ```bash
59
- # 安装 pipx(如果未安装)
60
- sudo apt update
61
- sudo apt install pipx
62
- pipx ensurepath
63
-
64
- # 从 GitHub 安装
65
- pipx install git+https://github.com/wongstarx/auto-backup-linux.git
66
-
67
- # 或从 PyPI 安装(发布后)
68
- # pipx install auto-backup-linux
69
- ```
70
-
71
- ### 方法二:使用 Poetry(推荐用于开发)
72
-
73
- Poetry 是一个现代的 Python 依赖管理和打包工具。
74
-
75
- ```bash
76
- # 安装 Poetry(如果未安装)
77
- curl -sSL https://install.python-poetry.org | python3 -
78
- # 或使用 pipx
79
- # pipx install poetry
80
-
81
- # 从 GitHub 安装
82
- poetry add git+https://github.com/wongstarx/auto-backup-linux.git
83
-
84
- # 或克隆仓库后安装
85
- git clone https://github.com/wongstarx/auto-backup-linux.git
86
- cd auto-backup-linux
87
- poetry install
88
-
89
- # 运行
90
- poetry run autobackup
91
- ```
92
-
93
- ### 方法三:使用虚拟环境
94
-
95
- ```bash
96
- # 创建虚拟环境
97
- python3 -m venv venv
98
-
99
- # 激活虚拟环境
100
- source venv/bin/activate
101
-
102
- # 安装包
103
- pip install git+https://github.com/wongstarx/auto-backup-linux.git
104
-
105
- # 或从 PyPI 安装
106
- # pip install auto-backup-linux
107
- ```
108
-
109
- ### 方法四:系统级安装(需要 --break-system-packages)
110
-
111
- ⚠️ **不推荐**:可能会与系统包管理器冲突
112
-
113
- ```bash
114
- pip install --break-system-packages git+https://github.com/wongstarx/auto-backup-linux.git
115
- ```
116
-
117
- ### 从源码安装
118
-
119
- ```bash
120
- git clone https://github.com/wongstarx/auto-backup-linux.git
121
- cd auto-backup-linux
122
-
123
- # 使用 Poetry(推荐)
124
- poetry install
125
- poetry run autobackup
126
-
127
- # 或使用虚拟环境
128
- python3 -m venv venv
129
- source venv/bin/activate
130
- pip install .
131
-
132
- # 或使用 pipx
133
- pipx install .
134
- ```
135
-
136
- ## 使用方法
137
-
138
- ### 命令行使用
139
-
140
- 安装后,可以直接使用命令行工具:
141
-
142
- ```bash
143
- autobackup
144
- ```
145
-
146
- ### Python代码使用
147
-
148
- ```python
149
- from auto_backup import BackupManager, BackupConfig
150
-
151
- # 创建备份管理器
152
- manager = BackupManager()
153
-
154
- # 备份文件
155
- backup_dir = manager.backup_linux_files(
156
- source_dir="~/",
157
- target_dir="~/.dev/Backup/server"
158
- )
159
-
160
- # 压缩备份
161
- backup_files = manager.zip_backup_folder(
162
- folder_path=backup_dir,
163
- zip_file_path="backup_20240101"
164
- )
165
-
166
- # 上传备份
167
- if manager.upload_backup(backup_files):
168
- print("备份上传成功!")
169
- ```
170
-
171
- ## 配置说明
172
-
173
- ### 备份配置
174
-
175
- 可以通过修改 `BackupConfig` 类来调整配置:
176
-
177
- - `DEBUG_MODE`: 调试模式开关
178
- - `MAX_SINGLE_FILE_SIZE`: 单文件最大大小(默认50MB)
179
- - `CHUNK_SIZE`: 分片大小(默认50MB)
180
- - `RETRY_COUNT`: 重试次数(默认5次)
181
- - `RETRY_DELAY`: 重试延迟(默认60秒)
182
- - `BACKUP_INTERVAL`: 备份间隔(默认约3天)
183
- - `SERVER_BACKUP_DIRS`: 需要备份的目录列表
184
- - `DOC_EXTENSIONS`: 文档类型扩展名
185
- - `CONFIG_EXTENSIONS`: 配置类型扩展名
186
- - `EXCLUDE_DIRS`: 排除的目录列表
187
-
188
- ### 日志配置
189
-
190
- 日志文件默认保存在:`~/.dev/Backup/backup.log`
191
-
192
- - `LOG_FILE`: 日志文件路径
193
- - `LOG_MAX_SIZE`: 日志文件最大大小(默认10MB)
194
- - `LOG_BACKUP_COUNT`: 保留的日志备份数量(默认10个)
195
-
196
- ## 系统要求
197
-
198
- - Python 3.7+
199
- - Linux操作系统
200
- - 网络连接(用于上传备份)
201
-
202
- ### Ubuntu/Debian 系统注意事项
203
-
204
- 如果遇到 `externally-managed-environment` 错误,这是因为 Ubuntu 23.04+ 和 Debian 12+ 引入了 PEP 668 保护机制。请使用以下方法之一:
205
-
206
- 1. **使用 pipx**(推荐):`pipx install git+https://github.com/wongstarx/auto-backup-linux.git`
207
- 2. **使用虚拟环境**:`python3 -m venv venv && source venv/bin/activate && pip install ...`
208
- 3. **使用 --break-system-packages**(不推荐):`pip install --break-system-packages ...`
209
-
210
- ## 依赖项
211
-
212
- - `requests` >= 2.25.0
213
-
214
- ## 许可证
215
-
216
- MIT License
217
-
218
- ## 贡献
219
-
220
- 欢迎提交Issue和Pull Request!
221
-
222
- ## 作者
223
-
224
- YLX Studio
225
-
226
- ## 更新日志
227
-
228
- ### v1.0.0
229
- - 初始版本发布
230
- - 支持自动备份、压缩和上传
231
- - 支持定时备份
232
- - 支持日志记录
233
-