winwin-cli 0.1.0__tar.gz

winwin_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 xuruikun
+
+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.

winwin_cli-0.1.0/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: winwin-cli
+Version: 0.1.0
+Summary: CLI 封装工具，专为 AI 使用设计
+Author: xuruikun
+License: MIT
+Project-URL: Homepage, https://github.com/yourusername/winwin-cli
+Project-URL: Repository, https://github.com/yourusername/winwin-cli
+Project-URL: Issues, https://github.com/yourusername/winwin-cli/issues
+Keywords: cli,ai,knowledge-base,search,document-conversion
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.1.0
+Requires-Dist: pyyaml>=6.0.0
+Requires-Dist: orjson>=3.9.0
+Requires-Dist: jieba>=0.42.0
+Requires-Dist: rank-bm25>=0.2.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: tqdm>=4.65.0
+Requires-Dist: markitdown>=0.1.4
+Dynamic: license-file
+
+# winwin-cli
+
+CLI 封装工具，专为 AI 使用设计。
+
+## 功能
+
+### kb-search - 知识库检索工具
+
+快速搜索你的文档，支持基于 BM25 的全文检索。
+
+**特性：**
+- 支持多种文档格式（Markdown、HTML、PDF、Office 文档等）
+- 基于 BM25 算法的全文检索
+- 自动文档索引和更新
+- 中文分词支持（jieba）
+- 多知识库管理
+- JSON 输出格式，便于 AI 解析
+
+**安装：**
+```bash
+# 使用 uvx 直接运行（无需安装）
+uvx winwin-cli kb-search --help
+
+# 或使用 uv pip 安装
+uv pip install winwin-cli
+winwin-cli kb-search --help
+```
+
+**快速开始：**
+```bash
+# 添加文档到知识库
+winwin-cli kb-search add my-kb ./docs
+
+# 搜索文档
+winwin-cli kb-search search my-kb "查询关键词"
+
+# 列出所有知识库
+winwin-cli kb-search list
+```
+
+### convert - 文档转换工具
+
+将各种格式的文档转换为 Markdown 或纯文本。
+
+**支持格式：**
+- Markdown (.md, .markdown)
+- HTML (.html, .htm)
+- PDF (.pdf)
+- Word 文档 (.docx, .doc)
+- PowerPoint (.pptx, .ppt)
+- Excel (.xlsx, .xls)
+- 纯文本 (.txt)
+
+**使用方法：**
+```bash
+# 转换单个文件
+winwin-cli convert document.docx output.md
+
+# 转换为纯文本
+winwin-cli convert document.pdf --format text
+```
+
+## 开发
+
+**环境设置：**
+```bash
+# 安装 uv
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# 安装依赖
+uv sync
+
+# 激活虚拟环境
+source .venv/bin/activate
+```
+
+**运行测试：**
+```bash
+uv pytest
+```
+
+**构建：**
+```bash
+uv build
+```
+
+## 项目结构
+
+```
+winwin-cli/
+├── src/winwin_cli/       # 源代码
+│   ├── cli.py           # 主入口
+│   ├── convert.py       # 文档转换模块
+│   └── kb_search/       # 知识库检索模块
+│       ├── cli.py       # kb-search 命令行
+│       ├── config.py    # 配置管理
+│       ├── indexer.py   # 文档索引
+│       ├── search.py    # 搜索引擎
+│       ├── models.py    # 数据模型
+│       └── commands/    # 子命令
+├── tests/               # 测试文件
+├── docs/                # 文档
+└── pyproject.toml       # 项目配置
+```
+
+## 许可证
+
+MIT License

winwin_cli-0.1.0/README.md

@@ -0,0 +1,108 @@
+# winwin-cli
+
+CLI 封装工具，专为 AI 使用设计。
+
+## 功能
+
+### kb-search - 知识库检索工具
+
+快速搜索你的文档，支持基于 BM25 的全文检索。
+
+**特性：**
+- 支持多种文档格式（Markdown、HTML、PDF、Office 文档等）
+- 基于 BM25 算法的全文检索
+- 自动文档索引和更新
+- 中文分词支持（jieba）
+- 多知识库管理
+- JSON 输出格式，便于 AI 解析
+
+**安装：**
+```bash
+# 使用 uvx 直接运行（无需安装）
+uvx winwin-cli kb-search --help
+
+# 或使用 uv pip 安装
+uv pip install winwin-cli
+winwin-cli kb-search --help
+```
+
+**快速开始：**
+```bash
+# 添加文档到知识库
+winwin-cli kb-search add my-kb ./docs
+
+# 搜索文档
+winwin-cli kb-search search my-kb "查询关键词"
+
+# 列出所有知识库
+winwin-cli kb-search list
+```
+
+### convert - 文档转换工具
+
+将各种格式的文档转换为 Markdown 或纯文本。
+
+**支持格式：**
+- Markdown (.md, .markdown)
+- HTML (.html, .htm)
+- PDF (.pdf)
+- Word 文档 (.docx, .doc)
+- PowerPoint (.pptx, .ppt)
+- Excel (.xlsx, .xls)
+- 纯文本 (.txt)
+
+**使用方法：**
+```bash
+# 转换单个文件
+winwin-cli convert document.docx output.md
+
+# 转换为纯文本
+winwin-cli convert document.pdf --format text
+```
+
+## 开发
+
+**环境设置：**
+```bash
+# 安装 uv
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# 安装依赖
+uv sync
+
+# 激活虚拟环境
+source .venv/bin/activate
+```
+
+**运行测试：**
+```bash
+uv pytest
+```
+
+**构建：**
+```bash
+uv build
+```
+
+## 项目结构
+
+```
+winwin-cli/
+├── src/winwin_cli/       # 源代码
+│   ├── cli.py           # 主入口
+│   ├── convert.py       # 文档转换模块
+│   └── kb_search/       # 知识库检索模块
+│       ├── cli.py       # kb-search 命令行
+│       ├── config.py    # 配置管理
+│       ├── indexer.py   # 文档索引
+│       ├── search.py    # 搜索引擎
+│       ├── models.py    # 数据模型
+│       └── commands/    # 子命令
+├── tests/               # 测试文件
+├── docs/                # 文档
+└── pyproject.toml       # 项目配置
+```
+
+## 许可证
+
+MIT License

winwin_cli-0.1.0/pyproject.toml

@@ -0,0 +1,55 @@
+[project]
+name = "winwin-cli"
+version = "0.1.0"
+description = "CLI 封装工具，专为 AI 使用设计"
+readme = "README.md"
+requires-python = ">=3.11"
+license = {text = "MIT"}
+authors = [
+    {name = "xuruikun"}
+]
+keywords = ["cli", "ai", "knowledge-base", "search", "document-conversion"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Utilities",
+]
+dependencies = [
+    "click>=8.1.0",
+    "pyyaml>=6.0.0",
+    "orjson>=3.9.0",
+    "jieba>=0.42.0",
+    "rank-bm25>=0.2.0",
+    "pydantic>=2.0.0",
+    "tqdm>=4.65.0",
+    "markitdown>=0.1.4",
+]
+
+[project.urls]
+Homepage = "https://github.com/yourusername/winwin-cli"
+Repository = "https://github.com/yourusername/winwin-cli"
+Issues = "https://github.com/yourusername/winwin-cli/issues"
+
+[project.scripts]
+winwin-cli = "winwin_cli.cli:main"
+
+[dependency-groups]
+dev = [
+    "pytest>=7.4.0",
+    "pytest-cov>=4.1.0",
+    "pytest-mock>=3.12.0",
+]
+
+[tool.uv]
+package = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+addopts = "-v --tb=short"

winwin_cli-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

winwin_cli-0.1.0/src/winwin_cli/__init__.py

@@ -0,0 +1,3 @@
+"""winwin-cli - CLI 封装工具，专为 AI 使用设计"""
+
+__version__ = "0.1.0"

winwin_cli-0.1.0/src/winwin_cli/cli.py

@@ -0,0 +1,45 @@
+"""winwin-cli 主入口"""
+
+import sys
+from typing import Optional
+import click
+
+
+@click.group()
+@click.version_option(version="0.1.0")
+def main():
+    """winwin-cli - CLI 封装工具，专为 AI 使用设计
+
+    提供各种命令行工具的封装，支持 AI 自动化调用。
+    """
+    pass
+
+
+def _import_kb_search():
+    """延迟导入 kb-search 模块"""
+    from winwin_cli.kb_search.cli import kb_search
+    return kb_search
+
+
+def _import_convert():
+    """延迟导入 convert 模块"""
+    from winwin_cli.convert import convert
+    return convert
+
+
+# 注册子命令
+try:
+    kb_search = _import_kb_search()
+    main.add_command(kb_search, "kb-search")
+except ImportError:
+    pass
+
+try:
+    convert_cmd = _import_convert()
+    main.add_command(convert_cmd)
+except ImportError:
+    pass
+
+
+if __name__ == "__main__":
+    main()

winwin_cli-0.1.0/src/winwin_cli/convert.py

@@ -0,0 +1,205 @@
+"""文档转换模块 - 将各种格式转换为 Markdown"""
+
+import sys
+from pathlib import Path
+from typing import Optional, List
+
+import click
+
+from winwin_cli.kb_search.markitdown import run_markitdown
+
+
+@click.command()
+@click.argument(
+    "input_path",
+    type=click.Path(exists=True),
+    required=True,
+)
+@click.option(
+    "--output",
+    "-o",
+    type=click.Path(),
+    help="输出目录或文件路径（默认：与输入文件同目录）",
+)
+@click.option(
+    "--ext",
+    "-e",
+    multiple=True,
+    help="文件扩展名过滤（可多次使用，如：--ext .docx --ext .pdf）",
+)
+@click.option(
+    "--overwrite",
+    "-f",
+    is_flag=True,
+    help="覆盖已存在的 Markdown 文件",
+)
+def convert(input_path: str, output: Optional[str], ext: tuple, overwrite: bool):
+    """转换文档为 Markdown 格式
+
+    支持的输入格式：
+    - Office: .docx, .doc, .pptx, .xlsx, .xls
+    - PDF: .pdf
+    - 图片（OCR）: .jpg, .jpeg, .png, .gif, .bmp, .webp
+    - 音频（语音转录）: .wav, .mp3, .m4a
+    - 视频: .mp4, .avi, .mov, .mkv
+    - 文本: .html, .htm, .csv, .json, .xml
+
+    用例：
+        # 转换单个文件
+        winwin-cli convert document.docx
+
+        # 转换目录中的所有文件
+        winwin-cli convert ./docs
+
+        # 转换并指定输出目录
+        winwin-cli convert ./docs -o ./markdown
+
+        # 只转换特定格式
+        winwin-cli convert ./docs --ext .pdf --ext .docx
+
+        # 覆盖已存在的 Markdown 文件
+        winwin-cli convert ./docs --overwrite
+    """
+    from tqdm import tqdm
+
+    input_path_obj = Path(input_path)
+
+    # 判断是文件还是目录
+    if input_path_obj.is_file():
+        # 转换单个文件
+        _convert_single_file(input_path_obj, output, overwrite)
+    else:
+        # 转换目录
+        _convert_directory(input_path_obj, output, ext, overwrite)
+
+
+def _convert_single_file(
+    input_file: Path,
+    output_path: Optional[str],
+    overwrite: bool,
+):
+    """转换单个文件
+
+    Args:
+        input_file: 输入文件路径
+        output_path: 输出路径（可选）
+        overwrite: 是否覆盖已存在的文件
+    """
+    # 确定输出路径
+    if output_path:
+        output_path_obj = Path(output_path)
+        if output_path_obj.is_dir():
+            # 如果是目录，文件名保持不变，扩展名改为 .md
+            output_file = output_path_obj / f"{input_file.stem}.md"
+        else:
+            # 如果是文件路径，直接使用
+            output_file = output_path_obj
+    else:
+        # 默认保存在同一目录
+        output_file = input_file.with_suffix(".md")
+
+    # 检查是否已存在
+    if output_file.exists() and not overwrite:
+        click.echo(f"⚠ 跳过（已存在）: {output_file}")
+        return
+
+    try:
+        click.echo(f"正在转换: {input_file.name}")
+        run_markitdown(str(input_file), str(output_file), "md")
+        click.echo(f"✓ 转换成功: {output_file}")
+    except Exception as e:
+        click.echo(f"✗ 转换失败: {input_file.name} - {e}", err=True)
+        sys.exit(1)
+
+
+def _convert_directory(
+    input_dir: Path,
+    output_path: Optional[str],
+    extensions: tuple,
+    overwrite: bool,
+):
+    """转换目录中的所有文件
+
+    Args:
+        input_dir: 输入目录路径
+        output_path: 输出目录路径（可选）
+        extensions: 文件扩展名过滤
+        overwrite: 是否覆盖已存在的文件
+    """
+    from tqdm import tqdm
+
+    # 支持的格式列表
+    supported_extensions = {
+        # Office 文档
+        ".docx", ".doc", ".pptx", ".xlsx", ".xls",
+        # PDF
+        ".pdf",
+        # 图片
+        ".jpg", ".jpeg", ".png", ".gif", ".bmp", ".webp",
+        # 音频
+        ".wav", ".mp3", ".m4a",
+        # 视频
+        ".mp4", ".avi", ".mov", ".mkv",
+        # 文本格式
+        ".html", ".htm", ".csv", ".json", ".xml",
+    }
+
+    # 确定输出目录
+    if output_path:
+        output_dir = Path(output_path)
+        output_dir.mkdir(parents=True, exist_ok=True)
+    else:
+        output_dir = input_dir
+
+    # 收集要转换的文件
+    files_to_convert = []
+    for ext in supported_extensions:
+        if extensions and ext not in extensions:
+            # 如果指定了扩展名过滤，跳过不在列表中的
+            continue
+        for file_path in input_dir.rglob(f"*{ext}"):
+            if file_path.is_file():
+                files_to_convert.append(file_path)
+
+    if not files_to_convert:
+        click.echo("未找到可转换的文件")
+        return
+
+    click.echo(f"\n找到 {len(files_to_convert)} 个文件")
+
+    # 统计
+    success_count = 0
+    skip_count = 0
+    error_count = 0
+
+    # 转换文件（显示进度条）
+    for input_file in tqdm(files_to_convert, desc="  转换进度", unit="文件"):
+        # 计算相对路径
+        try:
+            relative_path = input_file.relative_to(input_dir)
+        except ValueError:
+            # 文件不在 input_dir 下，使用文件名
+            relative_path = input_file.name
+
+        output_file = output_dir / relative_path.with_suffix(".md")
+        output_file.parent.mkdir(parents=True, exist_ok=True)
+
+        # 检查是否已存在
+        if output_file.exists() and not overwrite:
+            skip_count += 1
+            continue
+
+        try:
+            run_markitdown(str(input_file), str(output_file), "md")
+            success_count += 1
+        except Exception:
+            error_count += 1
+
+    # 显示结果
+    click.echo(f"\n转换完成:")
+    click.echo(f"  ✓ 成功: {success_count} 个文件")
+    if skip_count > 0:
+        click.echo(f"  ⊘ 跳过: {skip_count} 个文件（已存在）")
+    if error_count > 0:
+        click.echo(f"  ✗ 失败: {error_count} 个文件")
+        sys.exit(1)

winwin_cli-0.1.0/src/winwin_cli/kb_search/__init__.py

@@ -0,0 +1,37 @@
+"""知识库检索工具模块"""
+
+from winwin_cli.kb_search.cli import kb_search, search, list_kb, index, add, remove, enable, disable, status, info
+from winwin_cli.kb_search.search import KnowledgeBaseSearcher, SearchEngine
+from winwin_cli.kb_search.config import KnowledgeBaseLoader, load_global_config
+from winwin_cli.kb_search.indexer import KnowledgeBaseIndexer, BM25Indexer
+from winwin_cli.kb_search.models import (
+    KnowledgeBaseConfig,
+    SearchResult,
+    SearchRequest,
+    Document,
+    IndexInfo,
+)
+
+__all__ = [
+    "kb_search",
+    "search",
+    "list_kb",
+    "index",
+    "add",
+    "remove",
+    "enable",
+    "disable",
+    "status",
+    "info",
+    "KnowledgeBaseSearcher",
+    "SearchEngine",
+    "KnowledgeBaseLoader",
+    "load_global_config",
+    "KnowledgeBaseIndexer",
+    "BM25Indexer",
+    "KnowledgeBaseConfig",
+    "SearchResult",
+    "SearchRequest",
+    "Document",
+    "IndexInfo",
+]

winwin_cli-0.1.0/src/winwin_cli/kb_search/cli.py

@@ -0,0 +1,42 @@
+"""知识库检索工具 - CLI 模块（简化版）"""
+
+import click
+
+from winwin_cli.kb_search.commands import discover_commands
+
+
+@click.group()
+def kb_search():
+    """知识库检索工具 - 快速搜索你的文档"""
+    pass
+
+
+# Auto-discover and register all commands from the commands/ directory
+discovered = discover_commands(kb_search)
+
+
+# Export command functions for backward compatibility with tests
+# These are re-exported from their respective modules
+from winwin_cli.kb_search.commands.search import search
+from winwin_cli.kb_search.commands.list import list_kb
+from winwin_cli.kb_search.commands.index import index
+from winwin_cli.kb_search.commands.add import add
+from winwin_cli.kb_search.commands.remove import remove
+from winwin_cli.kb_search.commands.enable import enable
+from winwin_cli.kb_search.commands.disable import disable
+from winwin_cli.kb_search.commands.status import status
+from winwin_cli.kb_search.commands.info import info
+
+
+__all__ = [
+    "kb_search",
+    "search",
+    "list_kb",
+    "index",
+    "add",
+    "remove",
+    "enable",
+    "disable",
+    "status",
+    "info",
+]