doc2md-helper 0.1.0__tar.gz

doc2md_helper-0.1.0/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: doc2md-helper
+Version: 0.1.0
+Summary: Document converter for converting PDF, DOCX, Excel to Markdown, with MCP support
+Requires-Python: >=3.10
+Requires-Dist: mcp
+Requires-Dist: markitdown
+Requires-Dist: openpyxl
+Requires-Dist: python-docx
+Requires-Dist: mammoth
+Requires-Dist: PyPDF2
+Provides-Extra: marker
+Requires-Dist: marker-pdf; extra == "marker"
+Requires-Dist: torch; extra == "marker"
+Requires-Dist: bitsandbytes; extra == "marker"

doc2md_helper-0.1.0/README.md

@@ -0,0 +1,288 @@
+<h1 align="center">mcp-document-converter</h1>
+
+<p align="center">
+  <strong>一键安装，让 Claude Code 直接读取 PDF、Word、Excel！</strong>
+</p>
+
+<p align="center">
+  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square" alt="MIT Licence"></a>
+  <a href="https://www.python.org/"><img src="https://img.shields.io/badge/python-3.10%2B-blue.svg?style=flat-square" alt="Python 3.10+"></a>
+  <a href="https://modelcontextprotocol.io/"><img src="https://img.shields.io/badge/MCP-compatible-green.svg?style=flat-square" alt="MCP"></a>
+</p>
+
+<br>
+
+将 PDF、Word、Excel 文件转换为 Markdown，支持 MCP 集成和直接 CLI 调用两种方式。
+
+---
+
+## 🚀 快速开始（Windows 用户）
+
+### 方式一：一键安装（最简单）
+
+**双击运行 `install.bat`** 即可！
+
+安装完成后，重启 Claude Code 即可使用。
+
+### 方式二：手动安装
+
+```bash
+pip install mcp-document-converter
+mcp-document-converter install --platform claude-code  # 为 Claude Code 配置
+```
+
+---
+
+## 💡 两种使用方式
+
+### 方式一：直接让 Claude Code 调用（推荐）
+
+安装后，在 Claude Code 中直接说：
+
+```
+请帮我读取这个 report.pdf 文件
+```
+
+Claude Code 会先询问你想用哪种方式：
+1. **快速版本 (MarkItDown)** - 轻量快速，适合文本型 PDF
+2. **高精度版本 (Marker)** - 高精度 OCR，适合扫描版或复杂排版的 PDF
+
+选择后，自动开始转换！
+
+### 方式二：使用命令行
+
+```bash
+# 转换 PDF（轻量版）
+mcp-document-converter convert-pdf document.pdf
+
+# 转换 PDF（高精度 OCR 版）
+mcp-document-converter convert-pdf-marker scanned.pdf
+
+# 转换 Word
+mcp-document-converter convert-docx report.docx
+
+# 转换 Excel
+mcp-document-converter convert-excel data.xlsx
+
+# 保存到文件
+mcp-document-converter convert-pdf document.pdf -o output.md
+```
+
+---
+
+## 📦 安装选项
+
+### 基本安装
+
+```bash
+pip install mcp-document-converter
+```
+
+### 带 Marker 支持（PDF 高精度 OCR）
+
+```bash
+pip install mcp-document-converter[marker]
+```
+
+---
+
+## ⚙️ 配置平台
+
+### Claude Code
+
+```bash
+mcp-document-converter install --platform claude-code
+```
+
+配置将写入 `~/.claude/settings.json`。重启 Claude Code 后生效。
+
+### 其他平台
+
+同样支持 Cursor、Windsurf、Zed、Continue 等：
+
+```bash
+mcp-document-converter install --platform cursor
+```
+
+---
+
+## 🎯 PDF 转换的两个版本
+
+| 版本 | 说明 | 使用场景 | 依赖 |
+|------|------|---------|------|
+| **MarkItDown** | 轻量快速 | 文本型 PDF | markitdown |
+| **Marker** | 高精度 OCR | 扫描版、复杂排版 | marker-pdf, torch |
+
+---
+
+## 📚 完整 CLI 参考
+
+```bash
+# 转换命令
+mcp-document-converter convert-pdf    <文件路径>
+mcp-document-converter convert-pdf-marker <文件路径>
+mcp-document-converter convert-docx   <文件路径>
+mcp-document-converter convert-excel  <文件路径>
+
+# 配置命令
+mcp-document-converter install                       # 自动配置
+mcp-document-converter install --platform claude-code
+mcp-document-converter install --platform cursor
+
+# MCP 服务命令
+mcp-document-converter serve
+```
+
+---
+
+## 工作原理
+
+安装本包后，AI 编码工具可以通过 MCP 调用以下文档转换工具：
+
+1. 用户在对话中请求读取 PDF/Word/Excel 文件
+2. AI 编码工具调用对应的 MCP 转换工具
+3. 返回文件的 Markdown 内容，供 AI 理解和分析
+
+### PDF 转换的两个版本
+
+- **Marker 版本**（`convert_pdf_with_marker`）：基于 marker-pdf 库，支持高精度 OCR 和复杂排版识别，适合扫描版 PDF。需要 GPU 和额外的依赖（`pip install mcp-document-converter[marker]`）。
+- **MarkItDown 版本**（`convert_pdf_with_markitdown`）：基于 MarkItDown 库，轻量快速，适合文本型 PDF。无需 GPU。
+
+---
+
+## MCP 工具一览
+
+| 工具 | 说明 | 依赖 |
+|------|------|------|
+| `convert_pdf_with_marker` | 使用 marker 库将 PDF 转为 Markdown（高精度 OCR） | marker-pdf, torch |
+| `convert_pdf_with_markitdown` | 使用 MarkItDown 库将 PDF 转为 Markdown（轻量） | markitdown |
+| `convert_docx_to_markdown` | 将 Word 文档（.docx/.doc）转为 Markdown | mammoth / python-docx / textract |
+| `convert_excel_to_markdown` | 将 Excel 文件（.xlsx/.xls）转为 Markdown | markitdown / openpyxl |
+
+---
+
+## CLI 参考
+
+```bash
+mcp-document-converter install                       # 自动检测并配置所有支持的平台
+mcp-document-converter install --platform claude-code  # 仅配置 Claude Code
+mcp-document-converter install --platform cursor       # 仅配置 Cursor
+mcp-document-converter serve                           # 启动 MCP 服务器
+```
+
+---
+
+## 安装
+
+### 基本安装
+
+```bash
+pip install mcp-document-converter
+```
+
+### 带 Marker 支持（PDF 高精度转换）
+
+```bash
+pip install mcp-document-converter[marker]
+```
+
+### 开发模式
+
+```bash
+git clone <repository-url>
+cd mcp-document-converter
+pip install -e .
+```
+
+---
+
+## 配置平台
+
+### Claude Code
+
+```bash
+mcp-document-converter install --platform claude-code
+```
+
+配置将写入 `~/.claude/settings.json`。重启 Claude Code 后生效。
+
+### Cursor
+
+```bash
+mcp-document-converter install --platform cursor
+```
+
+配置将写入当前项目的 `.cursor/mcp.json`。重启 Cursor 后生效。
+
+### 手动配置
+
+如果自动配置失败，可以手动在对应平台的 MCP 配置中添加：
+
+```json
+{
+  "mcpServers": {
+    "mcp-document-converter": {
+      "command": "mcp-document-converter",
+      "args": ["serve"]
+    }
+  }
+}
+```
+
+如果使用 `uvx`：
+
+```json
+{
+  "mcpServers": {
+    "mcp-document-converter": {
+      "command": "uvx",
+      "args": ["mcp-document-converter", "serve"]
+    }
+  }
+}
+```
+
+---
+
+## 使用示例
+
+### 在 Claude Code 中使用
+
+安装并配置后，在对话中直接请求：
+
+```
+请读取 report.pdf 并总结内容
+```
+
+Claude Code 会自动调用 `convert_pdf_with_markitdown` 或 `convert_pdf_with_marker` 工具获取文件的 Markdown 内容。
+
+### 指定使用哪个 PDF 转换版本
+
+```
+请使用 marker 版本转换 design.pdf（需要高精度 OCR）
+```
+
+```
+请使用 markitdown 版本转换 notes.pdf（快速转换）
+```
+
+---
+
+## 支持的格式
+
+| 格式 | 扩展名 | 说明 |
+|------|--------|------|
+| PDF | .pdf | 支持文本型和扫描型 PDF |
+| Word | .docx, .doc | 支持多种后端（mammoth, python-docx, textract） |
+| Excel | .xlsx, .xls | 支持多工作表 |
+
+---
+
+## 开发
+
+```bash
+pip install -e .
+pytest
+```
+
+添加新的文件格式支持：在 `mcp_document_converter/` 中创建新的转换模块，然后在 `server.py` 中注册为 MCP 工具。

doc2md_helper-0.1.0/doc2md_helper.egg-info/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: doc2md-helper
+Version: 0.1.0
+Summary: Document converter for converting PDF, DOCX, Excel to Markdown, with MCP support
+Requires-Python: >=3.10
+Requires-Dist: mcp
+Requires-Dist: markitdown
+Requires-Dist: openpyxl
+Requires-Dist: python-docx
+Requires-Dist: mammoth
+Requires-Dist: PyPDF2
+Provides-Extra: marker
+Requires-Dist: marker-pdf; extra == "marker"
+Requires-Dist: torch; extra == "marker"
+Requires-Dist: bitsandbytes; extra == "marker"

doc2md_helper-0.1.0/doc2md_helper.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+README.md
+pyproject.toml
+doc2md_helper.egg-info/PKG-INFO
+doc2md_helper.egg-info/SOURCES.txt
+doc2md_helper.egg-info/dependency_links.txt
+doc2md_helper.egg-info/entry_points.txt
+doc2md_helper.egg-info/requires.txt
+doc2md_helper.egg-info/top_level.txt
+mcp_document_converter/__init__.py
+mcp_document_converter/cli.py
+mcp_document_converter/docx2markdown.py
+mcp_document_converter/excel2markdown.py
+mcp_document_converter/pdf2markdown.py
+mcp_document_converter/pdf2markdown_markitdown.py
+mcp_document_converter/server.py

doc2md_helper-0.1.0/doc2md_helper.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

doc2md_helper-0.1.0/doc2md_helper.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+doc2md-helper = mcp_document_converter.cli:main

doc2md_helper-0.1.0/doc2md_helper.egg-info/requires.txt

@@ -0,0 +1,11 @@
+mcp
+markitdown
+openpyxl
+python-docx
+mammoth
+PyPDF2
+
+[marker]
+marker-pdf
+torch
+bitsandbytes

doc2md_helper-0.1.0/doc2md_helper.egg-info/top_level.txt

@@ -0,0 +1 @@
+mcp_document_converter

doc2md_helper-0.1.0/mcp_document_converter/__init__.py

@@ -0,0 +1,29 @@
+# 条件导入 marker 版本（可选依赖）
+try:
+    from mcp_document_converter.pdf2markdown import convert_pdf_page_by_page
+    _has_marker = True
+except ImportError:
+    convert_pdf_page_by_page = None
+    _has_marker = False
+
+# 无条件导入其他模块
+from mcp_document_converter.pdf2markdown_markitdown import (
+    pdf_to_markdown_markitdown,
+    pdf_to_markdown_simple,
+)
+from mcp_document_converter.docx2markdown import docx_to_markdown
+from mcp_document_converter.excel2markdown import (
+    excel_to_markdown,
+    excel_to_markdown_simple,
+)
+
+# 构建 __all__
+__all__ = [
+    "pdf_to_markdown_markitdown",
+    "pdf_to_markdown_simple",
+    "docx_to_markdown",
+    "excel_to_markdown",
+    "excel_to_markdown_simple",
+]
+if _has_marker:
+    __all__.append("convert_pdf_page_by_page")