mikancli 0.2.1__tar.gz → 0.2.2__tar.gz

{mikancli-0.2.1 → mikancli-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mikancli
-Version: 0.2.1
+Version: 0.2.2
 Summary: CLI foundation for building qBittorrent RSS rules from anime search input.
 Author: metails
 Project-URL: Repository, https://github.com/JianHua-Deng/MikanCli
@@ -20,6 +20,7 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: InquirerPy>=0.3
+Requires-Dist: prompt-toolkit<4,>=3.0.52
 Requires-Dist: rich>=14.0
 
 # MikanCli
@@ -43,6 +44,12 @@ It supports both a guided interactive flow and a JSON preview mode for scripting
 - Submit RSS feeds and auto-download rules to qBittorrent, then verify that qBittorrent saved them
 - Print rule drafts as JSON without submitting anything
 
+## Screenshots
+
+![Search input (demo data)](docs/images/search-input.png)
+
+![RSS feed preview (demo data)](docs/images/feed-preview.png)
+
 ## Requirements
 
 - Python 3.10 or newer

{mikancli-0.2.1 → mikancli-0.2.2}/README.en.md

@@ -19,6 +19,12 @@ It supports both a guided interactive flow and a JSON preview mode for scripting
 - Submit RSS feeds and auto-download rules to qBittorrent, then verify that qBittorrent saved them
 - Print rule drafts as JSON without submitting anything
 
+## Screenshots
+
+![Search input (demo data)](docs/images/search-input.png)
+
+![RSS feed preview (demo data)](docs/images/feed-preview.png)
+
 ## Requirements
 
 - Python 3.10 or newer

{mikancli-0.2.1 → mikancli-0.2.2}/README.md

@@ -2,40 +2,46 @@
 
 语言：[简体中文](README.md) | [English](README.en.md)
 
-MikanCli 是一个 Python 命令行工具，用于在 Mikanani.me 上查找番剧/动画，选择正确的 Bangumi 和字幕组 RSS 订阅，并把该选择转换成 qBittorrent RSS 下载规则。
+MikanCli 是一个 Python 命令行工具，可以在 Mikanani.me 上搜索番剧/动画，选定对应的 Bangumi 条目和字幕组 RSS 订阅，并据此生成 qBittorrent 的 RSS 下载规则。
 
-它支持引导式交互流程，也支持用于脚本或检查的 JSON 预览模式。目前交互式流程是最完整的模式。
+它既提供引导式交互流程，也支持用于脚本或检查的 JSON 预览模式。目前交互式流程是功能最完整的模式。
 
 ## 功能
 
-- 根据动画标题或关键词搜索 Mikan
+- 按动画标题或关键词搜索 Mikan
 - 从匹配的 Bangumi 结果和字幕组 RSS 订阅中进行选择
 - 在确认订阅前分页预览最近的 RSS 条目
 - 使用 Rich 显示规则摘要、订阅预览和状态消息，并在网络请求期间显示加载指示器
 - 使用包含和排除过滤条件生成 qBittorrent RSS 规则
-- 过滤达到某个最低集数的动画标题格式
+- 按最低集数过滤动画发布标题
 - 选择并保存默认下载文件夹
-- 从命令行配置 qBittorrent WebUI 访问
+- 通过命令行配置 qBittorrent WebUI 访问
 - 将 RSS 订阅和自动下载规则提交到 qBittorrent，并验证 qBittorrent 已保存这些内容
-- 以 JSON 形式打印规则草稿，不提交任何内容
+- 以 JSON 形式输出规则草稿，不提交任何内容
+
+## 界面预览
+
+![搜索输入框（演示数据）](docs/images/search-input.png)
+
+![RSS 订阅预览（演示数据）](docs/images/feed-preview.png)
 
 ## 环境要求
 
 - Python 3.10 或更新版本
-- `pipx`，用于把 MikanCli 安装为独立命令行应用
+- `pipx`，用于将 MikanCli 安装为独立命令行应用
 - qBittorrent，如果你希望 MikanCli 自动提交 RSS 订阅和规则
 
 ## 快速开始 | 安装
 
-推荐使用 `pipx` 安装 MikanCli，这样你可以在任何终端中直接使用它。
-如果你已经安装了 `pipx`，可以跳过下面两条命令：
+推荐使用 `pipx` 安装 MikanCli，这样可以在任意终端中直接使用。
+如果已经安装 `pipx`，可以跳过以下两条命令：
 
 ```bash
 python -m pip install --user pipx           # 为当前用户安装 pipx
 python -m pipx ensurepath                   # 将 pipx 可执行文件目录添加到 PATH
 ```
 
-运行 `pipx ensurepath` 后，重新打开一个终端，然后执行：
+运行 `pipx ensurepath` 后，请重新打开一个终端，然后执行：
 
 ```bash
 pipx install mikancli
@@ -43,7 +49,7 @@ pipx install mikancli
 
 ## 使用方法
 
-安装完成后，运行下面的命令并按照菜单操作：
+安装完成后，运行以下命令，并按菜单提示操作：
 
 ```bash
 mikancli
@@ -59,22 +65,22 @@ cd MikanCli
 python -m pipx install -e .
 ```
 
-用于开发时，也可以使用可编辑的 `pip` 安装：
+开发时也可以使用可编辑模式的 `pip` 安装：
 
 ```bash
 python -m pip install -e .
 python -m mikancli
 ```
 
-依赖项（包括用于输出的 Rich 和用于交互提示的 InquirerPy）声明在 `pyproject.toml` 中，并由 `pip` 或 `pipx` 安装。MikanCli 不会在运行时安装依赖包。
+依赖项（包括用于输出的 Rich 和用于交互提示的 InquirerPy）声明在 `pyproject.toml` 中，由 `pip` 或 `pipx` 安装。MikanCli 运行时不会安装依赖包。
 
-已有可编辑 `pip` 安装在拉取依赖变更后，需要在原环境中重新运行 `python -m pip install -e .`。通过 `pipx` 安装的应用应使用 `pipx` 更新，让依赖仍安装在应用自己的环境中。
+如果已有可编辑模式的 `pip` 安装，在拉取依赖变更后，需要在原环境中重新运行 `python -m pip install -e .`。通过 `pipx` 安装的应用应使用 `pipx` 更新，以确保依赖仍安装在应用自己的环境中。
 
 ## 终端输出
 
-Rich 用于显示规则摘要、订阅预览和反馈消息，InquirerPy 负责菜单和文本输入。发布标题中的方括号会原样显示，较长的标题、URL 和路径会根据终端宽度自动换行。
+Rich 负责显示规则摘要、订阅预览和反馈消息，InquirerPy 负责菜单和文本输入。发布标题中的方括号会原样显示；较长的标题、URL 和路径会按终端宽度自动换行。
 
-交互式终端会在网络请求期间显示加载指示器，并在提示输入前或请求失败后停止。输出被重定向时，会使用静态状态消息，订阅预览保留纯文本布局。
+交互式终端会在网络请求期间显示加载指示器，并在提示输入前或请求失败后停止。输出被重定向时，会改用静态状态消息，订阅预览仍保留纯文本布局。
 
 在 PowerShell 中禁用 Rich 颜色：
 
@@ -85,48 +91,48 @@ mikancli
 
 使用 `Remove-Item Env:NO_COLOR` 移除此设置。粗体、暗色样式和加载动画可能仍会显示；菜单样式由 InquirerPy 单独管理。
 
-`--json` 草稿模式只输出一个 JSON 文档，不包含 Rich 格式或进度消息。
+`--json` 草稿模式只输出一个 JSON 文档，不使用 Rich 格式，也不显示进度消息。
 
 ## 引导式流程
 
-不带参数运行 `mikancli` 时，第一个菜单会让你选择：
+不带参数运行 `mikancli` 时，首先会看到菜单，可选择：
 
 - 搜索动画
 - 修改 qBittorrent 配置
 - 切换语言
 - 退出 MikanCli
 
-搜索流程会依次：
+搜索流程依次为：
 
-1. 询问动画标题或关键词
+1. 输入动画标题或关键词
 2. 在 Mikan 上搜索匹配的 Bangumi 条目
-3. 让你选择正确的 Bangumi 条目
+3. 选择正确的 Bangumi 条目
 4. 从所选 Bangumi 页面获取字幕组 RSS 订阅
-5. 让你选择字幕组
+5. 选择字幕组
 6. 预览最近的 RSS 订阅条目
-7. 询问包含、排除和最低集数过滤条件
-8. 询问下载保存位置
+7. 设置包含、排除和最低集数过滤条件
+8. 选择下载保存位置
 9. 生成规则草稿
 10. 将订阅和规则提交到 qBittorrent
-11. 通过 qBittorrent WebUI API 验证提交的订阅和规则
+11. 通过 qBittorrent WebUI API 验证订阅和规则已保存
 
-在需要输入文本的交互式提示中，可以输入 `exit` 或 `quit` 退出；菜单中也会包含退出选项。
+在需要输入文本的交互提示中，可输入 `exit` 或 `quit` 退出；菜单中也会提供退出选项。
 
 ## qBittorrent 设置
 
-在 MikanCli 可以提交订阅或规则之前，需要先启用 qBittorrent WebUI：
+在 MikanCli 提交订阅或规则之前，需要先启用 qBittorrent WebUI：
 
 1. 打开 qBittorrent 设置
 2. 启用 WebUI 或远程控制
-3. 确认 WebUI 地址、用户名和密码。如果地址为空，通常表示它是 `http://localhost:[port]`
+3. 确认 WebUI 地址、用户名和密码。地址为空通常表示 `http://localhost:[port]`
 4. 运行 `mikancli --setup-qbittorrent`
 
 设置说明：
 
-- URL 直接按 Enter 会使用 `http://localhost:8080`
+- URL 直接按 Enter 将使用 `http://localhost:8080`
 - 输入 `localhost:8080` 会自动规范化为 `http://localhost:8080`
-- 如果 qBittorrent WebUI 允许 localhost 绕过认证，用户名和密码可以留空
-- 如果 qBittorrent 拒绝连接，请重新检查 qBittorrent 设置里的 WebUI 端口和凭据
+- 如果 qBittorrent WebUI 允许 localhost 免认证访问，用户名和密码可以留空
+- 如果 qBittorrent 拒绝连接，请重新检查 qBittorrent 设置中的 WebUI 端口和凭据
 
 ## 配置
 
@@ -134,20 +140,20 @@ MikanCli 将配置保存在 JSON 文件中：
 
 - Windows：`%APPDATA%\Roaming\MikanCli\config.json`
 
-保存的设置可以包括：
+保存的设置可包括：
 
 - 默认下载文件夹
 - 语言偏好
 - qBittorrent WebUI URL
 - qBittorrent 用户名和密码
 - qBittorrent 分类
-- qBittorrent 是否应将匹配的种子以暂停状态添加
+- qBittorrent 是否以暂停状态添加匹配的种子
 
-qBittorrent 密码会保存在配置文件中，这样 MikanCli 后续运行时才能提交规则。共享机器上请保护好这个文件。
+qBittorrent 密码会保存在配置文件中，以便 MikanCli 后续运行时提交规则。在共享机器上请妥善保护该文件。
 
 ## 语言支持
 
-MikanCli 支持英文和简体中文的用户界面文本，包括交互式菜单、提示、设置说明、摘要和帮助文本。命令名称、选项名称、JSON 字段名、Mikan 标题、字幕组名称、URL 和 qBittorrent API 数据保持稳定。
+MikanCli 的面向用户 CLI 文本支持英文和简体中文，包括交互菜单、提示、设置说明、摘要和帮助文本。命令名、选项名、JSON 字段名、Mikan 标题、字幕组名称、URL 和 qBittorrent API 数据保持固定，不随语言变化。
 
 语言选择优先级如下：
 
@@ -156,8 +162,7 @@ MikanCli 支持英文和简体中文的用户界面文本，包括交互式菜
 3. 已保存的配置值
 4. 默认回退到英文
 
-交互式用户始终可以从启动菜单切换语言。选中的语言会保存到配置文件，供以后运行使用。
-
+交互式用户可随时从启动菜单切换语言。所选语言会保存到配置文件，供后续运行使用。
 
 ## 项目结构
 
@@ -192,15 +197,15 @@ usage: mikancli [-h] [--include INCLUDE] [--exclude EXCLUDE]
 - `--include VALUE`：要求已接受的发布标题中包含某个词或短语。可重复传入多个值
 - `--exclude VALUE`：拒绝标题中包含某个词或短语的发布。可重复传入多个值
 - `--min-episode NUMBER`：只接受达到此集数或更高集数的动画发布标题
-- `--save-path PATH`：为生成的 qBittorrent 规则使用这个基础下载文件夹
-- `--json`：以 JSON 形式打印规则草稿。此模式不会提交到 qBittorrent
+- `--save-path PATH`：为生成的 qBittorrent 规则使用该基础下载文件夹
+- `--json`：以 JSON 形式输出规则草稿。此模式不会提交到 qBittorrent
 - `--setup-qbittorrent`：配置并验证 qBittorrent WebUI 设置
 - `--language {en,zh-CN}`：为本次运行选择 CLI 语言
-- `--version`：打印已安装的 CLI 版本
+- `--version`：输出已安装的 CLI 版本
 
 ## 最低集数过滤
 
-当 RSS 条目标题使用常见的动画格式，并在集数前有短横线或使用方括号集数时，可以使用 `--min-episode`：
+当 RSS 条目标题采用常见动画格式，在集数前使用短横线或用方括号标注集数时，可以使用 `--min-episode`：
 
 ```text
 [SubsPlease] One Piece - 1126 (1080p)
@@ -213,10 +218,10 @@ usage: mikancli [-h] [--include INCLUDE] [--exclude EXCLUDE]
 mikancli "one piece" --include SubsPlease --min-episode 1126
 ```
 
-MikanCli 会把最低集数转换成 qBittorrent 规则 `mustContain` 字段中的正则表达式，并启用 `useRegex`。普通的 `--include` 和 `--exclude` 值仍然按字面词或短语处理，并且每个包含值都必须出现在标题中，qBittorrent 才会认为它匹配。
+MikanCli 会将最低集数转换为 qBittorrent 规则 `mustContain` 字段中的正则表达式，并启用 `useRegex`。普通的 `--include` 和 `--exclude` 值仍按字面词或短语处理；只有标题中包含所有 include 值，qBittorrent 才会视为匹配。
 
-提交最低集数规则时，MikanCli 会检查 qBittorrent 的 RSS 条目保留上限。如果 qBittorrent 每个订阅保留少于 500 个条目，MikanCli 会询问是否增加这个设置，让 qBittorrent 能看到足够多的 Mikan 订阅条目来匹配较新的集数。
+提交最低集数规则时，MikanCli 会检查 qBittorrent 的 RSS 条目保留上限。如果 qBittorrent 每个订阅保留的条目少于 500 条，MikanCli 会询问是否调高该设置，以便 qBittorrent 能看到足够多的 Mikan 订阅条目来匹配较新的集数。
 
 ## 发布
 
-仓库包含 GitHub Actions 工作流 `.github/workflows/publish.yml`。当 `main` 分支中 `pyproject.toml` 的包版本发生变化时，该工作流会发布到 PyPI。
+仓库包含 GitHub Actions 工作流 `.github/workflows/publish.yml`。当 `main` 分支中 `pyproject.toml` 的包版本发生变化时，该工作流会发布到 PyPI。

{mikancli-0.2.1 → mikancli-0.2.2}/mikancli/cli/input_parsing.py

@@ -6,9 +6,9 @@ from mikancli.display import print_message
 from mikancli.i18n import t
 
 
-def prompt_required_text(prompt: str) -> str:
+def prompt_required_text(prompt: str, *, boxed: bool = False) -> str:
     while True:
-        entered = collapse_spaces(prompt_text(prompt, allow_exit=True))
+        entered = collapse_spaces(prompt_text(prompt, allow_exit=True, boxed=boxed))
         if entered:
             return entered
         print_message(t("common.value_required"), style="warning")

{mikancli-0.2.1 → mikancli-0.2.2}/mikancli/cli/prompts.py

@@ -106,7 +106,7 @@ def select_option(
     return selected
 
 
-def prompt_text(message: str, *, default: str | None = None, allow_exit: bool = False) -> str:
+def prompt_text(message: str, *, default: str | None = None, allow_exit: bool = False, boxed: bool = False) -> str:
 
     inquirer = get_inquirer()
 
@@ -115,6 +115,9 @@ def prompt_text(message: str, *, default: str | None = None, allow_exit: bool =
         default=default or "",
         style=get_prompt_style(),
     )
+    if boxed and console.is_terminal:
+        # InquirerPy wraps PromptSession; its native frame preserves input editing.
+        prompt._session.show_frame = True
     entered = collapse_spaces(prompt.execute())
     if allow_exit and entered.casefold() in EXIT_TEXT_VALUES:
         raise ExitRequested()

{mikancli-0.2.1 → mikancli-0.2.2}/mikancli/cli/search_flow.py

@@ -37,6 +37,10 @@ def search_prompt(*, retry: bool = False) -> str:
     return t("search.prompt_retry" if retry else "search.prompt")
 
 
+def prompt_search_keyword(*, retry: bool = False) -> str:
+    return prompt_required_text(search_prompt(retry=retry), boxed=True)
+
+
 def select_candidate_or_search_again(candidates: tuple[MikanBangumi, ...], *, keyword: str) -> MikanBangumi | str:
 
     print_section(t("ui.search_results"), keyword)
@@ -179,7 +183,7 @@ def run_interactive_selection(*, initial_keyword: str | None) -> tuple[MikanBang
     
     keyword = collapse_spaces(initial_keyword or "")
     if not keyword:
-        keyword = prompt_required_text(search_prompt())
+        keyword = prompt_search_keyword()
 
     while True:
         try:
@@ -187,17 +191,17 @@ def run_interactive_selection(*, initial_keyword: str | None) -> tuple[MikanBang
                 candidates = search_mikan_bangumi(keyword)
         except MikanLookupError as exc:
             print_message(str(exc), style="error")
-            keyword = prompt_required_text(search_prompt(retry=True))
+            keyword = prompt_search_keyword(retry=True)
             continue
 
         if not candidates:
             print_message(t("search.no_results", keyword=keyword), style="warning")
-            keyword = prompt_required_text(search_prompt(retry=True))
+            keyword = prompt_search_keyword(retry=True)
             continue
 
         selected_candidate = select_candidate_or_search_again(candidates, keyword=keyword)
         if selected_candidate == SEARCH_AGAIN:
-            keyword = prompt_required_text(search_prompt(retry=True))
+            keyword = prompt_search_keyword(retry=True)
             continue
 
         bangumi = selected_candidate
@@ -222,7 +226,7 @@ def run_interactive_selection(*, initial_keyword: str | None) -> tuple[MikanBang
             if selected_subgroup == BACK_TO_CANDIDATES:
                 break
             if selected_subgroup == SEARCH_AGAIN:
-                keyword = prompt_required_text(search_prompt(retry=True))
+                keyword = prompt_search_keyword(retry=True)
                 break
 
             subgroup = selected_subgroup
@@ -238,7 +242,7 @@ def run_interactive_selection(*, initial_keyword: str | None) -> tuple[MikanBang
             if decision == BACK_TO_SUBGROUPS:
                 continue
             if decision == REJECT_SUBGROUP:
-                keyword = prompt_required_text(search_prompt(retry=True))
+                keyword = prompt_search_keyword(retry=True)
                 break
 
             return bangumi, subgroup

{mikancli-0.2.1 → mikancli-0.2.2}/mikancli/display.py

@@ -46,7 +46,7 @@ def print_section(title: str, *paragraphs: str) -> None:
 def loading(message: str) -> AbstractContextManager[object]:
     """Animate terminal requests, or print one static message when redirected."""
     if console.is_terminal and console.is_interactive:
-        return console.status(Text(message), spinner="line", spinner_style=PRIMARY_COLOR)
+        return console.status(Text(message), spinner="dots", spinner_style=PRIMARY_COLOR)
     print_message(message)
     return nullcontext()
 

{mikancli-0.2.1 → mikancli-0.2.2}/mikancli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mikancli
-Version: 0.2.1
+Version: 0.2.2
 Summary: CLI foundation for building qBittorrent RSS rules from anime search input.
 Author: metails
 Project-URL: Repository, https://github.com/JianHua-Deng/MikanCli
@@ -20,6 +20,7 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: InquirerPy>=0.3
+Requires-Dist: prompt-toolkit<4,>=3.0.52
 Requires-Dist: rich>=14.0
 
 # MikanCli
@@ -43,6 +44,12 @@ It supports both a guided interactive flow and a JSON preview mode for scripting
 - Submit RSS feeds and auto-download rules to qBittorrent, then verify that qBittorrent saved them
 - Print rule drafts as JSON without submitting anything
 
+## Screenshots
+
+![Search input (demo data)](docs/images/search-input.png)
+
+![RSS feed preview (demo data)](docs/images/feed-preview.png)
+
 ## Requirements
 
 - Python 3.10 or newer

{mikancli-0.2.1 → mikancli-0.2.2}/mikancli.egg-info/SOURCES.txt

@@ -32,4 +32,5 @@ mikancli/integrations/qbittorrent_client.py
 tests/test_cli_json.py
 tests/test_display.py
 tests/test_feed_preview.py
-tests/test_qbittorrent_episode_filter.py
+tests/test_qbittorrent_episode_filter.py
+tests/test_search_prompt.py

{mikancli-0.2.1 → mikancli-0.2.2}/mikancli.egg-info/requires.txt

@@ -1,2 +1,3 @@
 InquirerPy>=0.3
+prompt-toolkit<4,>=3.0.52
 rich>=14.0

{mikancli-0.2.1 → mikancli-0.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "mikancli"
-version = "0.2.1"
+version = "0.2.2"
 description = "CLI foundation for building qBittorrent RSS rules from anime search input."
 readme = "README.en.md"
 requires-python = ">=3.10"
@@ -27,6 +27,7 @@ classifiers = [
 ]
 dependencies = [
     "InquirerPy>=0.3",
+    "prompt-toolkit>=3.0.52,<4",
     "rich>=14.0",
 ]
 

{mikancli-0.2.1 → mikancli-0.2.2}/tests/test_display.py

@@ -40,6 +40,7 @@ class DisplayTests(TestCase):
                         raise failure
                 if terminal and interactive:
                     target.status.assert_called_once()
+                    self.assertEqual(target.status.call_args.kwargs["spinner"], "dots")
                     self.assertEqual(target.status.call_args.args[0].plain, literal)
                     target.status.return_value.__exit__.assert_called_once_with(ValueError, failure, ANY)
                     message.assert_not_called()

mikancli-0.2.2/tests/test_search_prompt.py

@@ -0,0 +1,35 @@
+from unittest import TestCase
+from unittest.mock import MagicMock, patch
+
+from InquirerPy import inquirer
+from prompt_toolkit.application import create_app_session
+from prompt_toolkit.input import DummyInput
+from prompt_toolkit.output import DummyOutput
+
+from mikancli.cli import input_parsing, prompts, search_flow
+
+
+class SearchPromptTests(TestCase):
+    def test_search_frame_survives_empty_retry_and_exit(self) -> None:
+        answers = iter(["", "  One   Piece  ", "quit", "other", "redirected"])
+        frames = []
+
+        def execute(widget):
+            frames.append(widget._session.show_frame)
+            return next(answers)
+
+        terminal = MagicMock(is_terminal=True)
+        with (
+            create_app_session(input=DummyInput(), output=DummyOutput()),
+            patch.object(inquirer.text, "execute", autospec=True, side_effect=execute),
+            patch.object(prompts, "console", terminal),
+            patch.object(input_parsing, "print_message") as warning,
+        ):
+            self.assertEqual(search_flow.prompt_search_keyword(), "One Piece")
+            with self.assertRaises(prompts.ExitRequested):
+                search_flow.prompt_search_keyword(retry=True)
+            self.assertEqual(prompts.prompt_text("Other"), "other")
+            terminal.is_terminal = False
+            self.assertEqual(search_flow.prompt_search_keyword(), "redirected")
+        self.assertEqual(frames, [True, True, True, False, False])
+        warning.assert_called_once()