2.7 Update (future)

2.7 Update (future)

README.md

@@ -1,13 +1,13 @@
 # AV Data Capture (CLI)
 
-CLI版本  
+CLI 版本  
 <a title="Hits" target="_blank" href="https://github.com/yoshiko2/AV_Data_Capture"><img src="https://hits.b3log.org/yoshiko2/AV_Data_Capture.svg"></a>
 ![](https://img.shields.io/badge/build-passing-brightgreen.svg?style=flat-square)
 ![](https://img.shields.io/github/downloads/yoshiko2/av_data_capture/total.svg?style=flat-square)
 ![](https://img.shields.io/github/license/yoshiko2/av_data_capture.svg?style=flat-square)
 ![](https://img.shields.io/github/release/yoshiko2/av_data_capture.svg?style=flat-square)
 ![](https://img.shields.io/badge/Python-3.7-yellow.svg?style=flat-square&logo=python)<br>
-[GUI版本](https://github.com/moyy996/AVDC)  
+[GUI 版本](https://github.com/moyy996/AVDC)  
 <a title="Hits" target="_blank" href="https://github.com/moyy996/avdc"><img src="https://hits.b3log.org/moyy996/AVDC.svg"></a>
 ![](https://img.shields.io/badge/build-passing-brightgreen.svg?style=flat-square)
 ![](https://img.shields.io/github/downloads/moyy996/avdc/total.svg?style=flat-square)
@@ -17,7 +17,7 @@ CLI版本
 ![](https://img.shields.io/badge/Pyqt-5-blue.svg?style=flat-square)<br>
 
 
-**日本电影元数据 抓取工具 | 刮削器**，配合本地影片管理软件EMBY,KODI等管理本地影片，该软件起到分类与元数据抓取作用，利用元数据信息来分类，供本地影片分类整理使用，本地电影刮削，整理一体化解决方案。  
+**日本电影元数据 抓取工具 | 刮削器**，配合本地影片管理软件 Emby, Jellyfin, Kodi 等管理本地影片，该软件起到分类与元数据（metadata）抓取作用，利用元数据信息来分类，供本地影片分类整理使用，本地电影刮削，整理一体化解决方案。
 
 # 目录
 * [声明](#声明)
@@ -25,116 +25,118 @@ CLI版本
 * [故事](#故事)
 * [效果图](#效果图)
 * [如何使用](#如何使用)
-* [下载](#下载)
+    * [下载](#下载)
-* [简明教程](#简要教程)
+    * [简要教程](#简要教程)
-* [模块安装](#1模块安装)
+* [完整文档](#完整文档)
-* [配置](#2配置configini)
+    * [模块安装](#模块安装)
-* [多目录影片处理](#4多目录影片处理)
+    * [配置](#配置configini)
-* [多集影片处理](#多集影片处理)
+    * [多目录影片处理](#多目录影片处理)
-* [(可选)设置自定义目录和影片重命名规则](#3可选设置自定义目录和影片重命名规则)
+    * [多集影片处理](#多集影片处理)
-* [运行软件](#5运行-av_data_capturepyexe)
+    * [中文字幕处理](#中文字幕处理)
-* [影片原路径处理](#4建议把软件拷贝和电影的统一目录下)
+    * [异常处理（重要）](#异常处理重要)
-* [异常处理（重要）](#51异常处理重要)
+* [写在后面](#写在后面)
-* [**拖动法**](#拖动法)
-* [导入至媒体库](#7把jav_output文件夹导入到embykodi中等待元数据刷新完成)
-* [关于群晖NAS](#8关于群晖NAS)
-* [写在后面](#9写在后面)
 
 # 声明
-* 本软件仅供**技术交流，学术交流**使用<br>
+* 本软件仅供**技术交流，学术交流**使用
-* 本软件作者编写出该软件旨在学习Python3，提高编程水平<br>
+* 本软件作者编写出该软件旨在学习 Python ，提高编程水平
-* 用户在使用该软件前，请用户自觉遵守当地法律法规，如果该软件使用过程中存在违反当地法律法规的行为，请勿使用该软件<br>
+* 用户在使用本软件前，请用户自觉遵守当地法律法规，如果本软件使用过程中存在违反当地法律法规的行为，请勿使用该软件
-* 用户使用该软件时，若产生一切违法行为由用户承担<br>
+* 用户在使用本软件时，若产生一切违法行为由用户承担
-* 严禁用户使用于商业和个人其他意图<br>
+* 严禁用户将本软件使用于商业和个人其他意图
-* 本软件作者保留最终决定权和最终解释权<br>
+* 本软件作者保留最终决定权和最终解释权
 
-**若用户不同意上述条款任意一条，请勿使用该软件**<br>
+**若用户不同意上述条款任意一条，请勿使用本软件**
 
 # FAQ
-### 这软件能下片吗？
+## 软件能下片吗？
-* 该软件不提供任何影片下载地址，仅供本地影片分类整理使用。
+* 本软件不提供任何影片下载地址，仅供本地影片分类整理使用
-### 什么是元数据？
+## 什么是元数据（metadata）？
-* 元数据包括了影片的：封面，导演，演员，简介，类型......
+* 元数据包括了影片的封面，导演，演员，简介，类型......
-### 软件收费吗？
+## 软件收费吗？
-* 软件永久免费。**除了作者钦点以外**
+* 本软件永久免费，**除了作者<ruby>钦<rt>yìng</rt></ruby>点以外**
-### 软件运行异常怎么办？
+## 软件运行异常怎么办？
-* 认真看 [异常处理（重要）](#5异常处理重要)
+* 认真看 [异常处理（重要）](#异常处理重要)
-### 为什么程序要单线程运行？
+## 为什么软件要单线程运行？
-如果多线程爬取会触发网站反爬机制，而且也违背了些道德，故单线程运行
+* 如果多线程爬取会触发网站反爬机制，而且也违背了些道德，故单线程运行
 
 # 故事
 [点击跳转至作者博客文章](https://yoshiko2.github.io/2019/10/18/AVDC/)
 
 # 效果图
-**图片来自网络**，由于相关法律法规，具体效果请自行联想
+**图片来自网络**，图片仅供参考，具体效果请自行联想
-![](https://i.loli.net/2019/07/04/5d1cf9bb1b08b86592.jpg)
+![preview_picture_1](https://i.loli.net/2019/07/04/5d1cf9bb1b08b86592.jpg)
-![](https://i.loli.net/2019/07/04/5d1cf9bb2696937880.jpg)<br>
+![preview_picture_2](https://i.loli.net/2019/07/04/5d1cf9bb2696937880.jpg)
 
 # 如何使用
-### 下载
+## 下载
-* release的程序可脱离**python环境**运行，可跳过 [模块安装](#1请安装模块在cmd终端逐条输入以下命令安装)<br>Release 下载地址(**仅限Windows**):<br>[![](https://img.shields.io/badge/%E4%B8%8B%E8%BD%BD-windows-blue.svg?style=for-the-badge&logo=windows)](https://github.com/yoshiko2/AV_Data_Capture/releases)<br>
+* release的程序可脱离**python环境**运行，可跳过 [模块安装](#模块安装)
-* Linux,MacOS请下载源码包运行
+### Windows
+Release 下载地址(**仅限Windows**):
 
-* Windows Python环境:[点击前往](https://www.python.org/downloads/windows/) 选中executable installer下载
+[![](https://img.shields.io/badge/%E4%B8%8B%E8%BD%BD-windows-blue.svg?style=for-the-badge&logo=windows)](https://github.com/yoshiko2/AV_Data_Capture/releases)
-* MacOS Python环境：[点击前往](https://www.python.org/downloads/mac-osx/)
-* Linux Python环境：Linux用户懂的吧，不解释下载地址
-### 简要教程:<br>
-**1.把软件拉到和电影的同一目录<br>2.设置ini文件的代理（路由器拥有自动代理功能的可以把proxy=后面内容去掉）<br>3.运行软件等待完成<br>4.把JAV_output导入至KODI,EMBY中。<br>详细请看以下教程**<br>
 
-## 1.模块安装
+* 若 Windows 用户需要运行源代码版本，请安装 Windows Python 环境:[点击前往](https://www.python.org/downloads/windows/) 选中 executable installer 下载
+
+### MacOS, Linux
+* MacOS, Linux 用户请下载源码包运行
+* MacOS Python环境：开箱即用，[可选安装最新版本](https://docs.brew.sh/Homebrew-and-Python)
+* Linux Python环境：开箱即用，可选安装最新版本，恕 Linux 版本众多请自行搜索
+
+## 简要教程:
+1. 把软件拉到和电影的同一目录
+2. 设置 config.ini 文件的代理（路由器拥有自动代理功能的可以把 proxy= 后面内容去掉）
+3. 运行软件等待完成
+4. 把 JAV_output 导入至 Kodi, Emby, Jellyfin 中。
+
+详细请看以下完整文档
+
+# 完整文档
+
+## 模块安装
 如果运行**源码**版，运行前请安装**Python环境**和安装以下**模块**  
-在终端/cmd/Powershell中输入以下代码来安装模块
-```python
-pip install requests
-```
-### 
-```python
-pip install pyquery
-```
-###
-```python
-pip install lxml
-```
-###
-```python
-pip install Beautifulsoup4
-```
-###
-```python
-pip install pillow
-```
-###
 
-## 2.配置config.ini
+在终端 cmd/Powershell/Terminal 中输入以下代码来安装模块
-#### 运行模式
->[common]<br>
->main_mode=1<br>
 
-1为普通模式<br>
+```python
+pip install requests pyquery lxml Beautifulsoup4 pillow
+```
+
+## 配置config.ini
+### 运行模式
+```
+[common]
+main_mode=1
+```
+1为普通模式，  
 2为整理模式：仅根据女优把电影命名为番号并分类到女优名称的文件夹下
 
->failed_output_folder=failed<br>
+```
->success_output_folder=JAV_outputd<br>
+success_output_folder=JAV_outputd
-
+failed_output_folder=failed
+```
 设置成功输出目录和失败输出目录
 
 ---
 #### 软链接
 方便PT下载完既想刮削又想继续上传的仓鼠党同志
->[common]  
+```
->soft_link=0  
+[common]
-
+soft_link=0
+```
 1为开启软链接模式  
 0为关闭
 
 ---
 ### 网络设置
->[proxy]  
+```
->proxy=127.0.0.1:1081  
+[proxy]  
->timeout=10  
+proxy=127.0.0.1:1081  
->retry=3  
+timeout=10  
+retry=3
+```  
 #### 针对某些地区的代理设置
->proxy=127.0.0.1:1081  
+```
+proxy=127.0.0.1:1081  
+```
 
 打开```config.ini```,在```[proxy]```下的```proxy```行设置本地代理地址和端口，支持Shadowxxxx/X,V2XXX本地代理端口  
 素人系列抓取建议使用日本代理  
@@ -144,92 +146,119 @@ pip install pillow
 
 ---
 #### 连接超时重试设置
->timeout=10  
+```
-
+timeout=10  
+```
 10为超时重试时间 单位：秒
 
 ---
 #### 连接重试次数设置
->retry=3  
+```
-
+retry=3  
+```
 3即为重试次数
 
 ---
 #### 检查更新开关
->[update]  
+```
->update_check=1  
+[update]  
-
+update_check=1  
+```
 0为关闭，1为开启，不建议关闭
 
 ---
 ### 媒体库选择 
->[media]<br>
+```
->media_warehouse=emby<br>
+[media]
->#emby plex kodi<br>
+media_warehouse=emby
-
+#emby plex kodi
-可选择emby, plex, kodi<br>
+```
+可选择emby, plex, kodi
 如果是PLEX，请安装插件：```XBMCnfoMoviesImporter```
 
 ---
 ### 排除指定字符和目录
->[escape]  
+```
->literals=\  
+[escape]  
->folders=failed,JAV_output  
+literals=\  
-```literals=``` 标题指定字符删除，例如```iterals=\()```，删除标题中```\()```字符  
+folders=failed,JAV_output
-```folders=``` 排指定目录，例如```folders=failed,JAV_output```，多目录刮削时跳过failed,JAV_output  
+```
+
+```literals=``` 标题指定字符删除，例如```iterals=\()```，则删除标题中```\()```字符  
+```folders=``` 指定目录，例如```folders=failed,JAV_output```，多目录刮削时跳过failed,JAV_output  
 
 ---
 ### 调试模式
->[debug_mode]<br>switch=1  
+```
+[debug_mode]
+switch=1  
+```
 
 如要开启调试模式，请手动输入以上代码到```config.ini```中，开启后可在抓取中显示影片元数据
 
 ---
-### 3.(可选)设置自定义目录和影片重命名规则
+### (可选)设置自定义目录和影片重命名规则
->[Name_Rule]<br>
+```
->location_rule=actor+'/'+number<br>
+[Name_Rule]
->naming_rule=number+'-'+title<br>
+location_rule=actor+'/'+number
-
+naming_rule=number+'-'+title
+```
 已有默认配置
 
 ---
 #### 命名参数
->title = 片名<br>
+```
->actor = 演员<br>
+title = 片名
->studio = 公司<br>
+actor = 演员
->director = 导演<br>
+studio = 公司
->release = 发售日<br>
+director = 导演
->year = 发行年份<br>
+release = 发售日
->number = 番号<br>
+year = 发行年份
->cover = 封面链接<br>
+number = 番号
->tag = 类型<br>
+cover = 封面链接
->outline = 简介<br>
+tag = 类型
->runtime = 时长<br>
+outline = 简介
+runtime = 时长
+```
 
 上面的参数以下都称之为**变量**
 
 #### 例子：
-自定义规则方法：有两种元素，变量和字符，无论是任何一种元素之间连接必须要用加号 **+** ，比如：```'naming_rule=['+number+']-'+title```，其中冒号 ' ' 内的文字是字符，没有冒号包含的文字是变量，元素之间连接必须要用加号 **+** <br>
+自定义规则方法：有两种元素，变量和字符，无论是任何一种元素之间连接必须要用加号 **+** ，比如：```'naming_rule=['+number+']-'+title```，其中冒号 ' ' 内的文字是字符，没有冒号包含的文字是变量，元素之间连接必须要用加号 **+** 
-目录结构规则：默认 ```location_rule=actor+'/'+number```<br> **不推荐修改时在这里添加title**，有时title过长，因为Windows API问题，抓取数据时新建文件夹容易出错。<br>
+
-影片命名规则：默认 ```naming_rule=number+'-'+title```<br> **在EMBY,KODI等本地媒体库显示的标题，不影响目录结构下影片文件的命名**，依旧是 番号+后缀。
+目录结构规则：默认 ```location_rule=actor+'/'+number```
+
+**不推荐修改时在这里添加 title**，有时 title 过长，因为 Windows API 问题，抓取数据时新建文件夹容易出错。
+
+影片命名规则：默认 ```naming_rule=number+'-'+title```
+
+**在 Emby, Kodi等本地媒体库显示的标题，不影响目录结构下影片文件的命名**，依旧是 番号+后缀。
 
 ---
 
 ### 更新开关
->[update]<br>update_check=1<br>
+```
+[update]
+update_check=1
+```
 
 1为开，0为关
 
-## 4.多目录影片处理
+## 多目录影片处理
 可以在多个有影片目录的父目录下搜索影片后缀，然后剪切到和程序同一目录下  
 
 ## 多集影片处理
 可以把多集电影按照集数后缀命名为类似```ssni-xxx-cd1.mp4m,ssni-xxx-cd2.mp4，abp-xxx-CD1.mp4```的规则，只要含有```-CDn./-cdn.```类似命名规则，即可使用分集功能
 
-## 5.运行 ```AV_Data_capture.py/.exe```
+## 中文字幕处理
-当文件名包含:<br>
+
+运行 ```AV_Data_capture.py/.exe```
+
+当文件名包含:
 中文，字幕，-c., -C., 处理元数据时会加上**中文字幕**标签
-## 5.1 异常处理（重要）
+
+## 异常处理（重要）
+
 ### 请确保软件是完整地！确保ini文件内容是和下载提供ini文件内容的一致的！
 ---
 ### 关于软件打开就闪退
@@ -249,42 +278,50 @@ pip install pillow
 
 ---
 ### 关于连接拒绝的错误
-请设置好[代理](#针对某些地区的代理设置)<br>
+请设置好[代理](#针对某些地区的代理设置)
 
 ---
 ### 关于Nonetype,xpath报错
-同上<br>
+同上
 
 ---
 ### 关于番号提取失败或者异常
-**目前可以提取元素的影片:JAVBUS上有元数据的电影，素人系列:300Maan,259luxu,siro等,FC2系列**<br>
+**目前可以提取元素的影片:JAVBUS上有元数据的电影，素人系列:300Maan,259luxu,siro等,FC2系列**
->下一张图片来自Pockies的blog 原作者已授权<br>
+
+>下一张图片来自 Pockies 的 blog 原作者已授权
 
 ![](https://raw.githubusercontent.com/Pockies/pic/master/741f9461gy1g1cxc31t41j20i804zdgo.jpg)
 
-目前作者已经完善了番号提取机制，功能较为强大，可提取上述文件名的的番号，如果出现提取失败或者异常的情况，请用以下规则命名<br>
+目前作者已经完善了番号提取机制，功能较为强大，可提取上述文件名的的番号，如果出现提取失败或者异常的情况，请用以下规则命名
+
 
 ```
 COSQ-004.mp4
 ```
 
 条件：文件名中间要有下划线或者减号"_","-"，没有多余的内容只有番号为最佳，可以让软件更好获取元数据
-对于多影片重命名，可以用[ReNamer](http://www.den4b.com/products/renamer)来批量重命名<br>
+对于多影片重命名，可以用 [ReNamer](http://www.den4b.com/products/renamer) 来批量重命名
+
 
 ---
 ### 关于PIL/image.py
 暂时无解，可能是网络问题或者pillow模块打包问题，你可以用源码运行（要安装好第一步的模块）  
+
 ### 拖动法
 针对格式比较奇葩的番号  
 影片放在和程序同一目录下，拖动至```AV_Data_Capture.exe```，即可完成刮削和整理
 
 
-## 6.软件会自动把元数据获取成功的电影移动到JAV_output文件夹中，根据演员分类，失败的电影移动到failed文件夹中。
+### 软件会自动把元数据获取成功的电影移动到 JAV_output 文件夹中，根据演员分类，失败的电影移动到failed文件夹中。
-## 7.把JAV_output文件夹导入到EMBY,KODI中，等待元数据刷新，完成
+
-## 8.关于群晖NAS
+### 把JAV_output文件夹导入到 Emby, Kodi中，等待元数据刷新，完成
-开启SMB在Windows上挂载为网络磁盘即可使用本软件，也适用于其他NAS
+
-## 9.写在后面
+### 关于群晖NAS
-怎么样，看着自己的日本电影被这样完美地管理，是不是感觉成就感爆棚呢?<br>
+开启 SMB，并在 Windows 上挂载为网络磁盘即可使用本软件，也适用于其他 NAS
-**tg官方电报群:[ 点击进群](https://t.me/joinchat/J54y1g3-a7nxJ_-WS4-KFQ)**<br>
+
+## 写在后面
+怎么样，看着自己的日本电影被这样完美地管理，是不是感觉成就感爆棚呢?
+
+**tg官方电报群:[ 点击进群](https://t.me/joinchat/J54y1g3-a7nxJ_-WS4-KFQ)**