下载本子Actions增加合并pdf的选项，更新文档 (hect0x7#489)

Author: hect0x7

.github/workflows/download_dispatch.yml

@@ -31,6 +31,15 @@ on:
         default: ''
         required: false
 
+      PDF_OPTION:
+        description: '是否要下载后将图片合并为pdf文件'
+        required: false
+        type: choice
+        options:
+          - 否
+          - 是 | 本子维度合并pdf
+          - 是 | 章节维度合并pdf
+
       ZIP_NAME:
         type: string
         default: 本子.tar.gz
@@ -68,6 +77,7 @@ jobs:
       ZIP_NAME: ${{ github.event.inputs.ZIP_NAME }}
       UPLOAD_NAME: ${{ github.event.inputs.UPLOAD_NAME }}
       IMAGE_SUFFIX: ${{ github.event.inputs.IMAGE_SUFFIX }}
+      PDF_OPTION: ${{ github.event.inputs.PDF_OPTION }}
 
       # 登录相关secrets
       JM_USERNAME: ${{ secrets.JM_USERNAME }}
@@ -95,6 +105,11 @@ jobs:
           python -m pip install --upgrade pip
           pip install -r requirements-dev.txt
 
+      - name: Install img2pdf
+        if: inputs.PDF_OPTION != '否'
+        run: |
+          pip install img2pdf
+
       - name: 安装jmcomic（pip）
         if: ${{ github.ref != 'refs/heads/dev' }}
         run: |

README.md

@@ -1,14 +1,32 @@
-# Python API For JMComic (禁漫天堂)
+<!-- 顶部标题 & 统计徽章 -->
+<div align="center">
+  <h1 style="margin-top: 0" align="center">Python API for JMComic</h1>
+  <p align="center">
+  <strong>提供 Python API 访问禁漫天堂（网页端 & 移动端），集成 GitHub Actions 下载器🚀</strong>
+  </p>
 
-本项目封装了一套可用于爬取JM的Python API.
+[![GitHub](https://img.shields.io/badge/-GitHub-181717?logo=github)](https://github.com/hect0x7)
+[![Stars](https://img.shields.io/github/stars/hect0x7/JMComic-Crawler-Python?color=orange&label=stars&style=flat)](https://github.com/hect0x7/JMComic-Crawler-Python/stargazers)
+[![Forks](https://img.shields.io/github/forks/hect0x7/JMComic-Crawler-Python?color=green&label=forks&style=flat)](https://github.com/hect0x7/JMComic-Crawler-Python/forks)
+[![GitHub latest releases](https://img.shields.io/github/v/release/hect0x7/JMComic-Crawler-Python?color=blue&label=version)](https://github.com/hect0x7/JMComic-Crawler-Python/releases/latest)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/jmcomic?style=flat&color=hotpink)](https://pepy.tech/projects/jmcomic)
+[![Licence](https://img.shields.io/github/license/hect0x7/JMComic-Crawler-Python?color=red)](https://github.com/hect0x7/JMComic-Crawler-Python)
 
-你可以通过简单的几行Python代码，实现下载JM上的本子到本地，并且是处理好的图片。
+</div>
+
+
+
+
+> 本项目封装了一套可用于爬取JM的Python API.
+> 
+> 你可以通过简单的几行Python代码，实现下载JM上的本子到本地，并且是处理好的图片。
+> 
+> **友情提示：珍爱JM，为了减轻JM的服务器压力，请不要一次性爬取太多本子，西门🙏🙏🙏**.
 
 [【指路】教程：使用GitHub Actions下载禁漫本子](./assets/docs/sources/tutorial/1_github_actions.md)
 
 [【指路】教程：导出并下载你的禁漫收藏夹数据](./assets/docs/sources/tutorial/10_export_favorites.md)
 
-**友情提示：珍爱JM，为了减轻JM的服务器压力，请不要一次性爬取太多本子，西门🙏🙏🙏**.
 
 ## 项目介绍
 
@@ -47,11 +65,11 @@
 
 ### 1. 下载本子方法
 
-只需要使用如下代码，就可以下载本子`JM422866`的所有章节的图片：
+只需要使用如下代码，就可以下载本子`JM123`的所有章节的图片：
 
 ```python
 import jmcomic  # 导入此模块，需要先安装.
-jmcomic.download_album('422866')  # 传入要下载的album的id，即可下载整个album到本地.
+jmcomic.download_album('123')  # 传入要下载的album的id，即可下载整个album到本地.
 ```
 
 上面的 `download_album`方法还有一个参数`option`，可用于控制下载配置，配置包括禁漫域名、网络代理、图片格式转换、插件等等。
@@ -80,8 +98,8 @@ import jmcomic
 # 创建配置对象
 option = jmcomic.create_option_by_file('你的配置文件路径，例如 D:/option.yml')
 # 使用option对象来下载本子
-jmcomic.download_album(422866, option)
-# 等价写法: option.download_album(422866)
+jmcomic.download_album(123, option)
+# 等价写法: option.download_album(123)
 ```
 
 ### 3. 使用命令行
@@ -91,10 +109,10 @@ jmcomic.download_album(422866, option)
 
 示例：
 
-下载本子422866的命令
+下载本子123的命令
 
 ```sh
-jmcomic 422866
+jmcomic 123
 ```
 同时下载本子123, 章节456的命令
 ```sh

usage/workflow_download.py

@@ -81,6 +81,19 @@ def cover_option_config(option: JmOption):
     if suffix is not None:
         option.download.image.suffix = fix_suffix(suffix)
 
+    pdf_option = env('PDF_OPTION', None)
+    if pdf_option and pdf_option != '否':
+        call_when = 'after_album' if pdf_option == '是 | 本子维度合并pdf' else 'after_photo'
+        plugin = [{
+            'plugin': Img2pdfPlugin.plugin_key,
+            'kwargs': {
+                'pdf_dir': option.dir_rule.base_dir + '/pdf/',
+                'filename_rule': call_when[6].upper() + 'id',
+                'delete_original_file': True,
+            }
+        }]
+        option.plugins[call_when] = plugin
+
 
 def log_before_raise():
     jm_download_dir = env('JM_DOWNLOAD_DIR', workspace())