kmoe-manga-downloader 1.0.0__py3-none-any.whl

kmoe_manga_downloader-1.0.0.dist-info/METADATA

@@ -0,0 +1,182 @@
+Metadata-Version: 2.4
+Name: kmoe-manga-downloader
+Version: 1.0.0
+Summary: A CLI-downloader for site @kox.moe.
+Author-email: Chris Zheng <chrisis58@outlook.com>
+License: MIT License
+        
+        Copyright (c) 2025 chris zheng
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/chrisis58/kmoe-manga-downloader
+Project-URL: Issues, https://github.com/chrisis58/kmoe-manga-downloader/issues
+Keywords: manga,downloader,kmoe
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: beautifulsoup4<5.0.0,>=4.11.1
+Requires-Dist: requests<3.0.0,>=2.32.3
+Requires-Dist: tqdm<5.0.0,>=4.67.1
+Requires-Dist: cloudscraper<2.0.0,>=1.2.71
+Dynamic: license-file
+
+# Kmoe Manga Downloader
+
+[![Unit Tests](https://github.com/chrisis58/kmdr/actions/workflows/unit-test.yml/badge.svg)](https://github.com/chrisis58/kmdr/actions/workflows/unit-test.yml) [![Interpretor](https://img.shields.io/badge/python-3.9+-blue)](https://www.python.org/) [![License](https://img.shields.io/badge/License-MIT-green)](https://github.com/chrisis58/kmdr/blob/main/LICENSE)
+
+`kmdr (Kmoe Manga Downloader)` 是一个 Python 脚本，用于从 [Kmoe](https://kox.moe/) 网站下载漫画。它支持在终端环境下的登录、下载指定书籍及其卷，并支持回调脚本执行。
+
+## ✨功能特性
+
+- 以命令行参数登录网站并持久化凭证
+- 支持多种方式筛选需要的内容
+- 支持网站上提供的不同的下载方式
+- 支持多线程下载，失败重试、断点续传
+- 提供自定义的下载完成回调命令
+- 提供通用配置持久化的实现
+
+## 🛠️安装依赖
+
+在使用本脚本之前，请确保你已经安装了项目所需要的依赖：
+
+```bash
+git clone https://github.com/chrisis58/kmoe-manga-downloader.git
+cd kmoe-manga-downloader
+
+pip install -r requirements.txt
+```
+
+## 📋使用方法
+
+### 1. 登录 `kmoe`
+
+首先需要登录 `kox.moe` 并保存登录状态（Cookie）。
+
+```bash
+python kmdr.py login -u <your_username> -p <your_password>
+```
+
+或者：
+
+```bash
+python kmdr.py login -u <your_username>
+```
+
+第二种方式会在程序运行时获取登录密码。如果登录成功，会同时显示当前登录用户及配额。
+
+### 2. 下载漫画书籍
+
+你可以通过以下命令下载指定书籍或卷：
+
+```bash
+# 在 path/to/destination 目录下载第一、二、三卷
+python kmdr.py download -d path/to/destination --book-url https://kox.moe/c/50076.htm --volume 1,2,3
+python kmdr.py download -d path/to/destination --book-url https://kox.moe/c/50076.htm -v 1-3
+```
+
+```bash
+# 在 path/to/download/destination 目录下载全部番外篇
+python kmdr.py download -d path/to/destination --book-url https://kox.moe/c/50076.htm --vol-type extra -v all
+```
+
+#### 常用参数说明：
+
+- `-d`, `--dest`: 下载的目标目录，在此基础上会额外添加一个为书籍名称的子目录
+- `-l`, `--book-url`: 指定书籍的主页地址
+- `-v`, `--volume`: 指定卷的名称，多个名称使用逗号分隔，`all` 表示下载所有卷
+- `-t`, `--vol-type`: 卷类型，`vol`: 单行本（默认）；`extra`: 番外；`seri`: 连载话；`all`: 全部
+- `-p`, `--proxy`: 代理服务器地址
+- `-r`, `--retry`: 下载失败时的重试次数
+- `-c`, `--callback`: 下载完成后的回调脚本（使用方式详见 [4. 回调函数](https://github.com/chrisis58/kmoe-manga-downlaoder?tab=readme-ov-file#4-%E5%9B%9E%E8%B0%83%E5%87%BD%E6%95%B0)）
+- `--num-workers`: 最大同时下载数量，默认为 1
+
+> 完整的参数说明可以从 `help` 指令中获取。
+
+### 3. 查看账户状态
+
+查看当前账户信息（例如：账户名和配额等）：
+
+```bash
+python kmdr.py status
+```
+
+### 4. 回调函数
+
+你可以设置一个回调函数，下载完成后执行。回调可以是任何你想要的命令：
+
+```bash
+python kmdr.py download -d path/to/destination --book-url https://kox.moe/c/50076.htm -v 1-3 \
+	--callback "echo '{b.name} {v.name} downloaded!' >> ~/kmdr.log"
+```
+
+> 字符串模板会直接朴素地替换，卷名或者书名可能会包含空格，推荐使用引号包含避免出现错误。
+
+`{b.name}, {v.name}` 会被分别替换为书籍和卷的名称。常用参数：
+
+| 变量名   | 描述           |
+| -------- | -------------- |
+| v.name   | 卷的名称       |
+| v.page   | 卷的页数       |
+| v.size   | 卷的文件大小   |
+| b.name   | 对应漫画的名字 |
+| b.author | 对应漫画的作者 |
+
+> 完整的可用参数请参考 [structure.py](https://github.com/chrisis58/kmdr/blob/main/core/structure.py#L11) 中关于 `VolInfo` 的定义。
+
+### 5. 持久化配置
+
+重复设置下载的代理服务器、目标路径等参数，可能会降低脚本的使用效率。所以脚本也提供了通用配置的持久化命令：
+
+```bash
+python kmdr.py config --set proxy=http://localhost:7890 dest=/path/to/destination
+python kmdr.py config -s num_workers=5 "callback=echo '{b.name} {v.name} downloaded!' >> ~/kmdr.log"
+```
+
+只需要配置一次即可对之后的所有的下载指令生效。
+
+> 注意：这里的参数名称不可以使用简写，例如 `dest` 不可用使用 `d` 来替换。
+
+同时，你也可以使用以下命令进行持久化配置的管理：
+
+- `-l`, `--list-option`: 显示当前存在的各个配置
+- `-s`, `--set`: 设置持久化的配置，键和值通过 `=` 分隔，设置多个配置可以通过空格间隔
+- `-c`, `--clear`: 清除配置，`all`: 清除所有；`cookie`: 退出登录；`option`: 清除持久化的配置
+- `-d`, `--delete`, `--unset`: 清除单项配置
+
+> 当前仅支持部分下载参数的持久化：`num_workers`, `dest`, `retry`, `callback`, `proxy`
+
+## ⚠️ 声明
+
+- 本工具仅作学习、研究、交流使用，使用本工具的用户应自行承担风险
+- 作者不对使用本工具导致的任何损失、法律纠纷或其他后果负责
+- 作者不对用户使用本工具的行为负责，包括但不限于用户违反法律或任何第三方权益的行为
+
+---
+
+<div align=center> 
+💬任何使用中遇到的问题、希望添加的功能，都欢迎提交 issue 或开 discussion 交流！<br />
+⭐ 如果这个项目对你有帮助，请给它一个星标！<br /> <br /> 
+<img src="https://counter.seku.su/cmoe?name=kmdr&theme=mbs" />
+</div>
+

kmoe_manga_downloader-1.0.0.dist-info/RECORD

@@ -0,0 +1,32 @@
+kmdr/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kmdr/main.py,sha256=WcY3gDnh3Qr2LkwkZQ5fwMdDd7OpT5w46lM3l_x6kOc,1183
+kmdr/core/__init__.py,sha256=6oreDxzipo3S11rhuLeZHGY2uke4gV4bA7NPTD5skvI,239
+kmdr/core/bases.py,sha256=hCk4IGPjx5FZJ1tdwFusYtZuwT75s3tn7O7-KBOXr28,3670
+kmdr/core/defaults.py,sha256=tP82FHlW4Ah38yNhwa1K25tYlRmw6dhBZxnzB31Utno,6062
+kmdr/core/registry.py,sha256=KYjvww5WRuUg5SeIeWZb96803-kgrTIKYvFTj_7bPfo,5560
+kmdr/core/structure.py,sha256=JHTuEHuRJLx1dEgg59WDJCZKORvwPJWuAb6nT1cSFNA,1163
+kmdr/core/utils.py,sha256=eBoj8O37kIQSN6S72EPpv83YRQlplBZ1FzEvehOLEKU,1953
+kmdr/module/__init__.py,sha256=aSuTcHhuBHUi1xNj5HTsXxhvegGBTRPNKj4JAPLC7LE,319
+kmdr/module/authenticator/CookieAuthenticator.py,sha256=vB_IvbWDelnRwCKKBP8yLB-NFa1q5QR4wNNNsi1pFmQ,774
+kmdr/module/authenticator/LoginAuthenticator.py,sha256=XeaenbrpnCj0Fs7aLV6zhoAdL0PvksUj4tnEPEzIcYM,1879
+kmdr/module/authenticator/utils.py,sha256=sVG2UTbQ1IdAtxUDHHjFts30WHik8ibC2zyFcGHXtP8,799
+kmdr/module/configurer/ConfigClearer.py,sha256=S5VxJ5latDK2-0Xf77_fVECXah7DhbI0exWE6AwUUkc,355
+kmdr/module/configurer/ConfigUnsetter.py,sha256=lik17kG7XJZ0J7AZ5z0jSUEOENbD0CML6wdHwaHbhXw,468
+kmdr/module/configurer/OptionLister.py,sha256=qc-nWPft_EtbEgJnz32h3nwGyGbe9oabKZpm6dIJi_o,516
+kmdr/module/configurer/OptionSetter.py,sha256=9MIkWZb-aFUTqpVCVrnri3JZTE0zO3CIYuN_nz5yzzY,842
+kmdr/module/configurer/option_validate.py,sha256=Pn9an9oFSpV8Jkz5uW12HprgyH7KJ_fo_ENEDLYxin0,2238
+kmdr/module/downloader/DirectDownloader.py,sha256=v13Bsr7TMspGOgxfX6F2aLO-wNUtHGa1R0zaiW9a08k,1016
+kmdr/module/downloader/ReferViaDownloader.py,sha256=0jbH0NWhhszjJsAHu5nkPt_Axzxp3AV8NR2sYaFdtCk,1641
+kmdr/module/downloader/utils.py,sha256=wBPmHiEHvFbdbyK4qmlkrzUFpl1LUOdZHY7Pg1s-1AY,3753
+kmdr/module/lister/BookUrlLister.py,sha256=Mq7EBXWSKd-6cygfkTjmOvgcUUaJI4NMQiaEIv9VDSk,470
+kmdr/module/lister/FollowedBookLister.py,sha256=_fShmCAsZQqboeuRtLBjo6d9CkGpat8xNKC3COtKllc,1537
+kmdr/module/lister/utils.py,sha256=0EHQIA05EZ1V0_SfkJ8demjzMRmFh9Q5qPvE6jvBqSU,2560
+kmdr/module/picker/ArgsFilterPicker.py,sha256=f3suMPPeFEtB3u7aUY63k_sGIOP196R-VviQ9RfDBTA,1756
+kmdr/module/picker/DefaultVolPicker.py,sha256=kpG5dvv1UKMhSA01VKGNB59zM5uszspyUVfRlL9aQA0,750
+kmdr/module/picker/utils.py,sha256=lpxM7q9BJeupFQy8glBrHu1o4E38dk7iLexzKytAE6g,1222
+kmoe_manga_downloader-1.0.0.dist-info/licenses/LICENSE,sha256=bKQlsXu8mAYKRZyoZKOEqMcCc8YjT5Q3Hgr21e0yU4E,1068
+kmoe_manga_downloader-1.0.0.dist-info/METADATA,sha256=DXGLAIc7JIibitm8Em96Zw5qCxiQ2_q2MfzLqm53SfU,7647
+kmoe_manga_downloader-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+kmoe_manga_downloader-1.0.0.dist-info/entry_points.txt,sha256=DGMytQAhx4uNuKQL7BPkiWESHLXkH-2KSEqwHdygNPA,47
+kmoe_manga_downloader-1.0.0.dist-info/top_level.txt,sha256=e0qxOgWp0tl3GLpmXGjZv3--q_TLoJ7GztM48Ov27wM,5
+kmoe_manga_downloader-1.0.0.dist-info/RECORD,,

kmoe_manga_downloader-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

kmoe_manga_downloader-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+kmdr = kmdr.main:entry_point

kmoe_manga_downloader-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 chris zheng
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

kmoe_manga_downloader-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+kmdr