novel-downloader 1.5.0__tar.gz → 2.0.0__tar.gz

novel_downloader-2.0.0/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: novel-downloader
+Version: 2.0.0
+Summary: A command-line tool for downloading Chinese web novels from Qidian and similar platforms.
+Author-email: Saudade Z <saudadez217@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 Saudade Z
+        
+        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/saudadez21/novel-downloader
+Project-URL: Source, https://github.com/saudadez21/novel-downloader
+Keywords: novel,web novel,qidian,biquge,ebook
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: Chinese (Simplified)
+Classifier: Topic :: Utilities
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rich
+Requires-Dist: nicegui
+Requires-Dist: requests
+Requires-Dist: aiohttp
+Requires-Dist: lxml
+Requires-Dist: platformdirs
+Provides-Extra: font-recovery
+Requires-Dist: numpy; extra == "font-recovery"
+Requires-Dist: fonttools; extra == "font-recovery"
+Requires-Dist: pillow; extra == "font-recovery"
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: types-requests; extra == "dev"
+Requires-Dist: types-lxml; extra == "dev"
+Requires-Dist: types-PyYAML; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: commitizen; extra == "dev"
+Dynamic: license-file
+
+# novel-downloader
+
+基于 [aiohttp](https://github.com/aio-libs/aiohttp) 的异步小说下载工具 / 库。支持断点续传、广告过滤与 TXT/EPUB 导出, 提供 CLI 与 Web 图形界面。
+
+> 运行要求: **Python 3.11+** (开发环境: Python 3.12)
+
+## 功能特性
+
+* **可恢复下载**: 运行时自动检测本地已完成的部分, 跳过已下载内容
+* **多格式导出**: 合并所有章节为
+  * `TXT`
+  * `EPUB` (可选打包章节插图)
+* **广告/活动过滤**:
+  * [x] 章节标题过滤
+  * [x] 章节正文过滤
+* **可选字体混淆还原**: `decode_font`
+* **双形态使用**: 命令行 (CLI) 与 Web 图形界面 (GUI)
+
+---
+
+## 安装
+
+使用 `pip` 安装稳定版:
+
+```bash
+pip install novel-downloader
+```
+
+启用字体解密功能 (`decode_font`):
+
+```bash
+pip install "novel-downloader[font-recovery]"
+```
+
+> 参见: [安装](https://github.com/saudadez21/novel-downloader/blob/main/docs/1-installation.md)
+
+---
+
+## 快速开始
+
+### 1. 初始化配置
+
+```bash
+# 生成默认配置 ./settings.toml
+novel-cli config init
+```
+
+编辑生成的 `./settings.toml`, 可修改 `request_interval`、`book_ids` 等配置 (参考 [settings.toml 配置说明](https://github.com/saudadez21/novel-downloader/blob/main/docs/3-settings-schema.md))
+
+### 2. 命令行 (CLI)
+
+```bash
+# 执行下载任务 (示例: 书籍 ID 为 123456, 默认站点为起点)
+novel-cli download 123456
+```
+
+* 支持站点见: [支持站点列表](https://github.com/saudadez21/novel-downloader/blob/main/docs/4-supported-sites.md)
+* 更多示例见: [CLI 使用示例](https://github.com/saudadez21/novel-downloader/blob/main/docs/5-cli-usage-examples.md)
+
+### 3. 图形界面 (GUI / Web)
+
+```bash
+# 启动 Web 界面 (基于当前 settings.toml)
+novel-web
+
+# 如需提供局域网/外网访问 (请自行留意安全与网络环境)
+# novel-web --listen public
+```
+
+---
+
+## 从源码安装 (开发版)
+
+体验最新开发功能:
+
+```bash
+git clone https://github.com/saudadez21/novel-downloader.git
+cd novel-downloader
+pip install .
+# 或安装带可选功能:
+# pip install .[font-recovery]
+```
+
+---
+
+## 文档导航
+
+* [安装](https://github.com/saudadez21/novel-downloader/blob/main/docs/1-installation.md)
+* [配置](https://github.com/saudadez21/novel-downloader/blob/main/docs/2-configuration.md)
+* [settings.toml 配置说明](https://github.com/saudadez21/novel-downloader/blob/main/docs/3-settings-schema.md)
+* [支持站点列表](https://github.com/saudadez21/novel-downloader/blob/main/docs/4-supported-sites.md)
+* [CLI 使用示例](https://github.com/saudadez21/novel-downloader/blob/main/docs/5-cli-usage-examples.md)
+* [复制 Cookies](https://github.com/saudadez21/novel-downloader/blob/main/docs/copy-cookies.md)
+* [文件保存](https://github.com/saudadez21/novel-downloader/blob/main/docs/file-saving.md)
+* [模块与接口文档](https://github.com/saudadez21/novel-downloader/blob/main/docs/api/README.md)
+* [TODO](https://github.com/saudadez21/novel-downloader/blob/main/docs/todo.md)
+* [开发](https://github.com/saudadez21/novel-downloader/blob/main/docs/develop.md)
+
+---
+
+## 项目说明
+
+* 本项目仅供学习和研究使用, **不得**用于任何商业或违法用途; 请遵守目标网站的 `robots.txt` 及相关法律法规
+* 由于网站结构可能变化或其他问题, 可能导致无法正常工作, 请按需自行调整代码或寻找其他解决方案
+* 使用本项目造成的任何法律责任由使用者自行承担, 项目作者不承担相关责任

novel_downloader-2.0.0/README.md

@@ -0,0 +1,105 @@
+# novel-downloader
+
+基于 [aiohttp](https://github.com/aio-libs/aiohttp) 的异步小说下载工具 / 库。支持断点续传、广告过滤与 TXT/EPUB 导出, 提供 CLI 与 Web 图形界面。
+
+> 运行要求: **Python 3.11+** (开发环境: Python 3.12)
+
+## 功能特性
+
+* **可恢复下载**: 运行时自动检测本地已完成的部分, 跳过已下载内容
+* **多格式导出**: 合并所有章节为
+  * `TXT`
+  * `EPUB` (可选打包章节插图)
+* **广告/活动过滤**:
+  * [x] 章节标题过滤
+  * [x] 章节正文过滤
+* **可选字体混淆还原**: `decode_font`
+* **双形态使用**: 命令行 (CLI) 与 Web 图形界面 (GUI)
+
+---
+
+## 安装
+
+使用 `pip` 安装稳定版:
+
+```bash
+pip install novel-downloader
+```
+
+启用字体解密功能 (`decode_font`):
+
+```bash
+pip install "novel-downloader[font-recovery]"
+```
+
+> 参见: [安装](https://github.com/saudadez21/novel-downloader/blob/main/docs/1-installation.md)
+
+---
+
+## 快速开始
+
+### 1. 初始化配置
+
+```bash
+# 生成默认配置 ./settings.toml
+novel-cli config init
+```
+
+编辑生成的 `./settings.toml`, 可修改 `request_interval`、`book_ids` 等配置 (参考 [settings.toml 配置说明](https://github.com/saudadez21/novel-downloader/blob/main/docs/3-settings-schema.md))
+
+### 2. 命令行 (CLI)
+
+```bash
+# 执行下载任务 (示例: 书籍 ID 为 123456, 默认站点为起点)
+novel-cli download 123456
+```
+
+* 支持站点见: [支持站点列表](https://github.com/saudadez21/novel-downloader/blob/main/docs/4-supported-sites.md)
+* 更多示例见: [CLI 使用示例](https://github.com/saudadez21/novel-downloader/blob/main/docs/5-cli-usage-examples.md)
+
+### 3. 图形界面 (GUI / Web)
+
+```bash
+# 启动 Web 界面 (基于当前 settings.toml)
+novel-web
+
+# 如需提供局域网/外网访问 (请自行留意安全与网络环境)
+# novel-web --listen public
+```
+
+---
+
+## 从源码安装 (开发版)
+
+体验最新开发功能:
+
+```bash
+git clone https://github.com/saudadez21/novel-downloader.git
+cd novel-downloader
+pip install .
+# 或安装带可选功能:
+# pip install .[font-recovery]
+```
+
+---
+
+## 文档导航
+
+* [安装](https://github.com/saudadez21/novel-downloader/blob/main/docs/1-installation.md)
+* [配置](https://github.com/saudadez21/novel-downloader/blob/main/docs/2-configuration.md)
+* [settings.toml 配置说明](https://github.com/saudadez21/novel-downloader/blob/main/docs/3-settings-schema.md)
+* [支持站点列表](https://github.com/saudadez21/novel-downloader/blob/main/docs/4-supported-sites.md)
+* [CLI 使用示例](https://github.com/saudadez21/novel-downloader/blob/main/docs/5-cli-usage-examples.md)
+* [复制 Cookies](https://github.com/saudadez21/novel-downloader/blob/main/docs/copy-cookies.md)
+* [文件保存](https://github.com/saudadez21/novel-downloader/blob/main/docs/file-saving.md)
+* [模块与接口文档](https://github.com/saudadez21/novel-downloader/blob/main/docs/api/README.md)
+* [TODO](https://github.com/saudadez21/novel-downloader/blob/main/docs/todo.md)
+* [开发](https://github.com/saudadez21/novel-downloader/blob/main/docs/develop.md)
+
+---
+
+## 项目说明
+
+* 本项目仅供学习和研究使用, **不得**用于任何商业或违法用途; 请遵守目标网站的 `robots.txt` 及相关法律法规
+* 由于网站结构可能变化或其他问题, 可能导致无法正常工作, 请按需自行调整代码或寻找其他解决方案
+* 使用本项目造成的任何法律责任由使用者自行承担, 项目作者不承担相关责任

{novel_downloader-1.5.0 → novel_downloader-2.0.0}/pyproject.toml

@@ -7,7 +7,7 @@ authors = [
 license = {file = "LICENSE"}
 readme = {file = "README.md", content-type = "text/markdown"}
 requires-python = ">=3.11"
-keywords = ["novel", "web novel", "qidian", "biquge", "downloader", "parser", "fiction", "cli", "automation", "ebook"]
+keywords = ["novel", "web novel", "qidian", "biquge", "ebook"]
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Environment :: Console",
@@ -21,15 +21,21 @@ classifiers = [
 ]
 dynamic = ["version"]
 dependencies = [
-    "textual",
+    "rich",
+    "nicegui",
     "requests",
     "aiohttp",
-    "playwright",
     "lxml",
-    "platformdirs"
+    "platformdirs",
 ]
 
 [project.optional-dependencies]
+font-recovery = [
+    "numpy",
+    "fonttools",
+    "pillow",
+]
+
 dev = [
     "black",
     "mypy",
@@ -44,24 +50,13 @@ dev = [
     "commitizen"
 ]
 
-font-recovery = [
-    "scipy",
-    "numpy",
-    "tinycss2",
-    "fonttools",
-    "brotli",
-    "opencv-python",
-    "pillow",
-    "huggingface_hub"
-]
-
 [project.scripts]
 novel-cli = "novel_downloader.cli.main:cli_main"
-novel-tui = "novel_downloader.tui.main:tui_main"
+novel-web = "novel_downloader.web.main:web_main"
 
 [project.urls]
-Homepage = "https://github.com/BowenZ217/novel-downloader"
-Source = "https://github.com/BowenZ217/novel-downloader"
+Homepage = "https://github.com/saudadez21/novel-downloader"
+Source = "https://github.com/saudadez21/novel-downloader"
 
 [build-system]
 requires = ["setuptools>=61.0", "wheel"]
@@ -79,7 +74,6 @@ include = ["novel_downloader", "novel_downloader.*"]
 "novel_downloader.locales" = ["*.json"]
 "novel_downloader.resources.css_styles" = ["*.css"]
 "novel_downloader.resources.images" = ["*.png"]
-"novel_downloader.tui.styles" = ["*.tcss"]
 
 [tool.setuptools.dynamic]
 version = {attr = "novel_downloader.__version__"}
@@ -116,7 +110,7 @@ testpaths = ["tests"]
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "1.5.0"
+version = "2.0.0"
 version_files = [
     "src/novel_downloader/__init__.py"
 ]

{novel_downloader-1.5.0 → novel_downloader-2.0.0}/src/novel_downloader/__init__.py

@@ -6,7 +6,7 @@ novel_downloader
 Core package for the Novel Downloader project.
 """
 
-__version__ = "1.5.0"
+__version__ = "2.0.0"
 
 __author__ = "Saudade Z"
 __email__ = "saudadez217@gmail.com"

{novel_downloader-1.5.0 → novel_downloader-2.0.0}/src/novel_downloader/cli/__init__.py

@@ -6,8 +6,6 @@ novel_downloader.cli
 This module exposes the CLI entry point.
 """
 
-__all__ = [
-    "cli_main",
-]
+__all__ = ["cli_main"]
 
 from .main import cli_main

novel_downloader-2.0.0/src/novel_downloader/cli/clean.py

@@ -0,0 +1,78 @@
+#!/usr/bin/env python3
+"""
+novel_downloader.cli.clean
+--------------------------
+
+CLI subcommands for clean resources.
+"""
+
+from __future__ import annotations
+
+import shutil
+from argparse import Namespace, _SubParsersAction
+from pathlib import Path
+
+from novel_downloader.cli import ui
+from novel_downloader.utils.constants import (
+    CONFIG_DIR,
+    DATA_DIR,
+    JS_SCRIPT_DIR,
+    LOGGER_DIR,
+)
+from novel_downloader.utils.i18n import t
+
+
+def register_clean_subcommand(subparsers: _SubParsersAction) -> None:  # type: ignore
+    """Register the `clean` subcommand and its options."""
+    parser = subparsers.add_parser("clean", help=t("help_clean"))
+
+    parser.add_argument("--logs", action="store_true", help=t("clean_logs"))
+    parser.add_argument("--cache", action="store_true", help=t("clean_cache"))
+    parser.add_argument("--data", action="store_true", help=t("clean_data"))
+    parser.add_argument("--config", action="store_true", help=t("clean_config"))
+    parser.add_argument("--all", action="store_true", help=t("clean_all"))
+    parser.add_argument("-y", "--yes", action="store_true", help=t("clean_yes"))
+
+    parser.set_defaults(func=handle_clean)
+
+
+def handle_clean(args: Namespace) -> None:
+    """Handle the `clean` subcommand."""
+    targets: list[Path] = []
+
+    if args.all:
+        if not args.yes and not ui.confirm(t("clean_confirm"), default=False):
+            ui.warn(t("clean_cancelled"))
+            return
+        targets = [LOGGER_DIR, JS_SCRIPT_DIR, DATA_DIR, CONFIG_DIR]
+    else:
+        if args.logs:
+            targets.append(LOGGER_DIR)
+        if args.cache:
+            targets.append(JS_SCRIPT_DIR)
+        if args.data:
+            targets.append(DATA_DIR)
+        if args.config:
+            targets.append(CONFIG_DIR)
+
+    if not targets:
+        ui.warn(t("clean_nothing"))
+        return
+
+    for path in targets:
+        _delete_path(path)
+
+
+def _delete_path(p: Path) -> None:
+    """Delete file or directory at `p`, printing a colored result line."""
+    if p.exists():
+        try:
+            if p.is_file():
+                p.unlink()
+            else:
+                shutil.rmtree(p, ignore_errors=True)
+            ui.success(f"[clean] {t('clean_deleted')}: {p}")
+        except Exception as e:
+            ui.error(f"[clean] {t('clean_failed', path=p)}: {p} -> {e}")
+    else:
+        ui.warn(f"[clean] {t('clean_not_found')}: {p}")

{novel_downloader-1.5.0 → novel_downloader-2.0.0}/src/novel_downloader/cli/config.py

@@ -3,14 +3,17 @@
 novel_downloader.cli.config
 ---------------------------
 
-CLI subcommands for configuration management.
+CLI subcommands for configuration file management.
 """
 
+from __future__ import annotations
+
 import shutil
 from argparse import Namespace, _SubParsersAction
 from importlib.resources import as_file
 from pathlib import Path
 
+from novel_downloader.cli import ui
 from novel_downloader.config import save_config_file
 from novel_downloader.utils.constants import DEFAULT_SETTINGS_PATHS
 from novel_downloader.utils.i18n import t
@@ -18,6 +21,7 @@ from novel_downloader.utils.state import state_mgr
 
 
 def register_config_subcommand(subparsers: _SubParsersAction) -> None:  # type: ignore
+    """Register `config` with `init`, `set-lang`, and `set-config` subcommands."""
     parser = subparsers.add_parser("config", help=t("help_config"))
     config_subparsers = parser.add_subparsers(dest="subcommand", required=True)
 
@@ -27,26 +31,30 @@ def register_config_subcommand(subparsers: _SubParsersAction) -> None:  # type:
 
 
 def _register_init(subparsers: _SubParsersAction) -> None:  # type: ignore
-    parser = subparsers.add_parser("init", help=t("settings_init_help"))
+    parser = subparsers.add_parser("init", help=t("config_init_help"))
     parser.add_argument(
-        "--force", action="store_true", help=t("settings_init_force_help")
+        "--force", action="store_true", help=t("config_init_force_help")
     )
     parser.set_defaults(func=_handle_init)
 
 
 def _register_set_lang(subparsers: _SubParsersAction) -> None:  # type: ignore
-    parser = subparsers.add_parser("set-lang", help=t("settings_set_lang_help"))
+    parser = subparsers.add_parser("set-lang", help=t("config_set_lang_help"))
     parser.add_argument("lang", choices=["zh", "en"], help="Language code")
     parser.set_defaults(func=_handle_set_lang)
 
 
 def _register_set_config(subparsers: _SubParsersAction) -> None:  # type: ignore
-    parser = subparsers.add_parser("set-config", help=t("settings_set_config_help"))
+    parser = subparsers.add_parser("set-config", help=t("config_set_config_help"))
     parser.add_argument("path", type=str, help="Path to YAML config file")
     parser.set_defaults(func=_handle_set_config)
 
 
 def _handle_init(args: Namespace) -> None:
+    """
+    Copy template settings files from package resources into the current working dir.
+    If the target file exists, optionally confirm overwrite (unless --force).
+    """
     cwd = Path.cwd()
 
     for resource in DEFAULT_SETTINGS_PATHS:
@@ -55,41 +63,38 @@ def _handle_init(args: Namespace) -> None:
 
         if target_path.exists():
             if args.force:
-                print(t("settings_init_overwrite", filename=resource.name))
+                ui.warn(t("config_init_overwrite", filename=resource.name))
             else:
-                print(t("settings_init_exists", filename=resource.name))
-                resp = (
-                    input(
-                        t("settings_init_confirm_overwrite", filename=resource.name)
-                        + " [y/N]: "
-                    )
-                    .strip()
-                    .lower()
+                ui.info(t("config_init_exists", filename=resource.name))
+                should_copy = ui.confirm(
+                    t("config_init_confirm_overwrite", filename=resource.name),
+                    default=False,
                 )
-                should_copy = resp == "y"
 
         if not should_copy:
-            print(t("settings_init_skip", filename=resource.name))
+            ui.warn(t("config_init_skip", filename=resource.name))
             continue
 
         try:
             with as_file(resource) as actual_path:
                 shutil.copy(actual_path, target_path)
-                print(t("settings_init_copy", filename=resource.name))
+                ui.success(t("config_init_copy", filename=resource.name))
         except Exception as e:
-            print(t("settings_init_error", filename=resource.name, err=str(e)))
+            ui.error(t("config_init_error", filename=resource.name, err=str(e)))
             raise
 
 
 def _handle_set_lang(args: Namespace) -> None:
+    """Set the UI language and persist in state manager."""
     state_mgr.set_language(args.lang)
-    print(t("settings_set_lang", lang=args.lang))
+    ui.success(t("config_set_lang", lang=args.lang))
 
 
 def _handle_set_config(args: Namespace) -> None:
+    """Persist a user-supplied TOML config path into the app config."""
     try:
         save_config_file(args.path)
-        print(t("settings_set_config", path=args.path))
+        ui.success(t("config_set_config", path=args.path))
     except Exception as e:
-        print(t("settings_set_config_fail", err=str(e)))
+        ui.error(t("config_set_config_fail", err=str(e)))
         raise