Merge pull request #1 from ruchuby/develop

TinyPNG-Unlimited v0.0.1

.gitignore

@@ -127,3 +127,10 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# custom
+.idea
+bin/tmp
+bin/keys.json
+bin/*.json
+bin/tasks.py

README.md

@@ -1 +1,120 @@
-# tinypng-unlimited
+# tinypng-unlimited
+
+## 介绍
+
+### TinyPNG
+
+TinyPNG使用将WebP, PNG and JPEG图片进行智能有损压缩，该压缩对视觉的影响几乎不可见，但是能显著压缩文件体积，以节省空间储存，方便网络传输。
+
+通过邮箱免费申请TinyPNG官方API秘钥，可以获得每月500张图片的免费压缩次数（不限文件大小）。
+
+因此，通过API进行图片批量压缩是相对理想的形式，[申请地址]([TinyPNG – Developer API](https://tinypng.com/developers))
+
+### tinypng-unlimited
+
+> 本项目仅供技术研究使用，请勿用于任何商业及非法用途，任何后果作者概不负责！
+
+**本项目可自动申请API秘钥，以多线程形式批量进行TinyPNG压缩，并附带上传、下载和总体任务的进度条，旨在提供最方便快捷的云压缩功能**
+
+本项目实现的功能：
+
+1. 通过多个临时邮箱自动申请TinyPNG官方API秘钥，以实现**无限制使用TinyPNG**
+2. **自动切换不可用秘钥**（即将达到500次免费压缩的秘钥）
+3. 多线程上传下载图片，**加快批量压缩进度**
+4. 可选**使用代理**上传、下载图片
+5. 可选**递归子文件夹**，可通过**正则匹配**需要压缩的文件名
+6. 可选**通过配置文件批量添加**图片文件名、文件夹任务列表
+7. 可选**输出压缩日志**到图片输出文件夹目录
+8. 显示上传、下载和总体任务的**进度条**
+9. 为每个压缩后的图片添加压缩标记字节（不影响图片内容），**避免重复压缩**
+10. 上传、下载带有**超时时间**
+11. **压缩错误自动重试**，超出重试次数输出错误文件列表，下次运行时自动重新压缩
+
+
+
+## 安装
+
+方式一：
+
+1. 下载本项目文件
+
+2. 安装依赖
+
+	```
+	pip install -r requirements.txt
+	```
+
+方式二：
+
+1. 下载已编译命令行工具：[TinyPNG-Unlimited.exe](https://github.com/ruchuby/TinyPNG-Unlimited/releases)
+
+
+
+### 使用
+
+1. 压缩单文件
+    ```bash
+    path\to\your\python main.py file "path\to\your\image"
+    TinyPNG-Unlimited.exe file "path\to\your\image"
+    ```
+
+2. 压缩单文件夹
+   ```bash
+   path\to\your\python main.py dir "path\to\your\image\dir"
+   TinyPNG-Unlimited.exe dir "path\to\your\image\dir"
+   ```
+
+3. 使用配置文件批量压缩
+	```bash
+    path\to\your\python main.py tasks "path\to\tasks.json"
+    TinyPNG-Unlimited.exe dir "path\to\tasks.json"
+	```
+	tasks-emample.json: 
+
+	```json
+	{
+		"file_tasks": ["D:\\1.jpg", "D:\\2.jpg"],
+		"dir_tasks": ["D:\\dir1", "D:\\dir2"]
+	}
+	```
+
+	参考 [tasks-help.txt](https://github.com/ruchuby/TinyPNG-Unlimited/blob/develop/bin/tasks-help.txt)
+
+4. 申请API秘钥
+
+   程序运行时会自动申请秘钥，但也可以通过此方式再次申请
+	```bash
+    path\to\your\python main.py apply 4
+    TinyPNG-Unlimited.exe apply 4
+	```
+
+5. 重新排列API秘钥顺序
+
+	依次请求获取本地储存的API秘钥压缩次数，重新排列秘钥顺序
+
+	```bash
+	path\to\your\python main.py rearrange
+	TinyPNG-Unlimited.exe rearrange
+	```
+
+6. 更多细节请使用命令行帮助，或者打开项目源码查看
+
+   ```bash
+   TinyPNG-Unlimited.exe -h
+   TinyPNG-Unlimited.exe file -h
+   TinyPNG-Unlimited.exe dir -h
+   TinyPNG-Unlimited.exe tasks -h
+   TinyPNG-Unlimited.exe apply -h
+   TinyPNG-Unlimited.exe rearrange -h
+   ```
+
+
+
+
+## 截图
+
+<img src="https://pic1.imgdb.cn/item/636a58ea16f2c2beb165ee92.jpg" alt="image-20221108212239001" style="zoom:50%;" />
+
+<img src="https://pic1.imgdb.cn/item/636a592b16f2c2beb1664075.jpg" alt="image-20221108212228078" style="zoom:50%;" />
+
+<img src="https://pic1.imgdb.cn/item/636a597c16f2c2beb166a678.jpg" style="zoom:50%;" />