multi-ocr-py 0.1.0__tar.gz

multi_ocr_py-0.1.0/.gitignore

@@ -0,0 +1,179 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+tests/1.txt
+tests/2.txt
+tests/1.md
+tests/2.md
+tests/3.md
+temp
+.DS_Store

multi_ocr_py-0.1.0/.python-version

@@ -0,0 +1 @@
+3.11

multi_ocr_py-0.1.0/LICENSE

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

multi_ocr_py-0.1.0/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.4
+Name: multi-ocr-py
+Version: 0.1.0
+Summary: 多引擎 OCR 工具包：将 PDF 和图片转换为 Markdown，支持 CLI 全局安装和 SDK 依赖两种使用方式
+Project-URL: Repository, https://github.com/BlackBoxRecorder/multi-ocr
+Author-email: Yinnan <im.yinnan@outlook.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: cli,markdown,ocr,pdf,vision-language-model
+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 :: Scientific/Engineering :: Image Recognition
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Requires-Python: >=3.11
+Requires-Dist: liteparse
+Requires-Dist: ollama
+Requires-Dist: openai>=2.45.0
+Requires-Dist: pymupdf>=1.28.0
+Requires-Dist: tqdm>=4.67.0
+Description-Content-Type: text/markdown
+
+# multi-ocr
+
+多引擎 OCR 工具包，将 PDF 和图片转换为 Markdown 文档。
+
+- **CLI 工具**：全局安装后一行命令完成 OCR
+- **SDK 依赖**：作为 Python 库集成到你的项目中
+
+## 支持的引擎
+
+| 引擎 | 说明 | 类型 |
+|---|---|---|
+| SiliconFlow + DeepSeek-OCR | 云端 OCR，精度高 | API |
+| SiliconFlow + PaddleOCR-VL-1.5 | 云端 OCR，轻量快速 | API |
+| DashScope + Qwen-VL-OCR | 阿里云百炼 | API |
+| LiteParse | 本地 PDF 解析，无需联网 | 本地 |
+| Ollama + DeepSeek-OCR | 本地部署 OCR | 本地 |
+
+## 安装
+
+### CLI 全局安装
+
+```bash
+uv tool install multi-ocr
+# 或
+pip install multi-ocr
+```
+
+### SDK 依赖安装
+
+```bash
+pip install multi-ocr
+# 或
+uv add multi-ocr
+```
+
+## CLI 使用
+
+```bash
+# 单文件 OCR
+multi-ocr document.pdf
+
+# 指定引擎和页码范围
+multi-ocr document.pdf --model dashscope-qwen-vl-ocr --pages 1-5
+
+# 批量处理目录
+multi-ocr ./scans/ --model silicon-deepseek-ocr -j 4
+
+# 查看帮助
+multi-ocr --help
+```
+
+### 环境变量
+
+| 引擎 | 环境变量 |
+|---|---|
+| SiliconFlow | `SILICONFLOW_API_KEY` |
+| DashScope | `DASHSCOPE_API_KEY` |
+| Ollama | `OLLAMA_BASE_URL`（可选，默认 http://127.0.0.1:11434）|
+
+也可通过 `--api-key` 参数直接传入。
+
+## SDK 使用
+
+```python
+from pathlib import Path
+from multi_ocr import get_engine, ocr_file, OCREngine
+
+# 创建引擎
+engine = get_engine(
+    provider="siliconflow",
+    model="deepseek-ai/DeepSeek-OCR",
+    api_key="your-api-key",
+)
+
+# 识别图片
+text = engine.parse_image(Path("scan.jpg"))
+
+# 识别 PDF
+result = ocr_file(Path("document.pdf"), engine, pages="1-3")
+
+# 批量处理目录
+from multi_ocr import ocr_directory
+ocr_directory(Path("./scans/"), engine, concurrency=4)
+```
+
+### 自定义引擎
+
+```python
+from multi_ocr import OCREngine
+
+class MyEngine(OCREngine):
+    def parse_image(self, image_path: Path) -> str:
+        # 你的 OCR 逻辑
+        return "recognized text"
+```
+
+## 要求
+
+- Python >= 3.11
+
+## 协议
+
+MIT License

multi_ocr_py-0.1.0/README.md

@@ -0,0 +1,103 @@
+# multi-ocr
+
+多引擎 OCR 工具包，将 PDF 和图片转换为 Markdown 文档。
+
+- **CLI 工具**：全局安装后一行命令完成 OCR
+- **SDK 依赖**：作为 Python 库集成到你的项目中
+
+## 支持的引擎
+
+| 引擎 | 说明 | 类型 |
+|---|---|---|
+| SiliconFlow + DeepSeek-OCR | 云端 OCR，精度高 | API |
+| SiliconFlow + PaddleOCR-VL-1.5 | 云端 OCR，轻量快速 | API |
+| DashScope + Qwen-VL-OCR | 阿里云百炼 | API |
+| LiteParse | 本地 PDF 解析，无需联网 | 本地 |
+| Ollama + DeepSeek-OCR | 本地部署 OCR | 本地 |
+
+## 安装
+
+### CLI 全局安装
+
+```bash
+uv tool install multi-ocr
+# 或
+pip install multi-ocr
+```
+
+### SDK 依赖安装
+
+```bash
+pip install multi-ocr
+# 或
+uv add multi-ocr
+```
+
+## CLI 使用
+
+```bash
+# 单文件 OCR
+multi-ocr document.pdf
+
+# 指定引擎和页码范围
+multi-ocr document.pdf --model dashscope-qwen-vl-ocr --pages 1-5
+
+# 批量处理目录
+multi-ocr ./scans/ --model silicon-deepseek-ocr -j 4
+
+# 查看帮助
+multi-ocr --help
+```
+
+### 环境变量
+
+| 引擎 | 环境变量 |
+|---|---|
+| SiliconFlow | `SILICONFLOW_API_KEY` |
+| DashScope | `DASHSCOPE_API_KEY` |
+| Ollama | `OLLAMA_BASE_URL`（可选，默认 http://127.0.0.1:11434）|
+
+也可通过 `--api-key` 参数直接传入。
+
+## SDK 使用
+
+```python
+from pathlib import Path
+from multi_ocr import get_engine, ocr_file, OCREngine
+
+# 创建引擎
+engine = get_engine(
+    provider="siliconflow",
+    model="deepseek-ai/DeepSeek-OCR",
+    api_key="your-api-key",
+)
+
+# 识别图片
+text = engine.parse_image(Path("scan.jpg"))
+
+# 识别 PDF
+result = ocr_file(Path("document.pdf"), engine, pages="1-3")
+
+# 批量处理目录
+from multi_ocr import ocr_directory
+ocr_directory(Path("./scans/"), engine, concurrency=4)
+```
+
+### 自定义引擎
+
+```python
+from multi_ocr import OCREngine
+
+class MyEngine(OCREngine):
+    def parse_image(self, image_path: Path) -> str:
+        # 你的 OCR 逻辑
+        return "recognized text"
+```
+
+## 要求
+
+- Python >= 3.11
+
+## 协议
+
+MIT License

multi_ocr_py-0.1.0/docs/liteparse/Markdown-Output.md

@@ -0,0 +1,101 @@
+---
+title: Markdown Output | Developer Documentation
+description: Render documents to clean, structured Markdown for LLMs and RAG pipelines.
+---
+
+LiteParse can render documents directly to Markdown, reconstructing headings, tables, lists, images, and links from the spatial layout. This is ideal for feeding documents to LLMs and RAG pipelines, where clean, structured text matters more than exact visual fidelity.
+
+Markdown is a first-class output format alongside `text` and `json`.
+
+## CLI
+
+Terminal window
+
+```
+# Render a document to Markdown
+lit parse document.pdf --format markdown -o output.md
+
+
+# Print Markdown to stdout
+lit parse document.pdf --format markdown
+```
+
+### Images
+
+By default, raster images are emitted as Markdown placeholders (`![](image_pN_K.png)`) in reading order. Control this with `--image-mode`:
+
+| Mode                    | Behavior                                                                |
+| ----------------------- | ----------------------------------------------------------------------- |
+| `placeholder` (default) | Emit `![](image_pN_K.png)` references in reading order                  |
+| `off`                   | Strip images entirely                                                   |
+| `embed`                 | Write each image’s PNG bytes to `--image-output-dir` and reference them |
+
+Terminal window
+
+```
+# Strip images
+lit parse document.pdf --format markdown --image-mode off
+
+
+# Extract embedded images to disk and reference them from the markdown
+lit parse document.pdf --format markdown --image-mode embed --image-output-dir ./images
+```
+
+### Links
+
+Hyperlink annotations are rendered as `[text](url)` by default. Pass `--no-links` to emit the anchor text as plain text instead:
+
+Terminal window
+
+```
+lit parse document.pdf --format markdown --no-links
+```
+
+## Library
+
+The rendered Markdown is returned on `result.text`.
+
+```
+import { LiteParse } from "@llamaindex/liteparse";
+
+
+const parser = new LiteParse({
+  outputFormat: "markdown",   // "json" | "text" | "markdown"
+  imageMode: "placeholder",   // "placeholder" | "off" | "embed" (default: "placeholder")
+  extractLinks: true,         // render [text](url) link syntax (default: true)
+});
+const result = await parser.parse("document.pdf");
+console.log(result.text); // rendered Markdown
+```
+
+```
+from liteparse import LiteParse
+
+
+parser = LiteParse(
+    output_format="markdown",   # "json" | "text" | "markdown"
+    image_mode="placeholder",   # "placeholder" | "off" | "embed"
+    extract_links=True,         # render [text](url) link syntax (default: True)
+)
+result = parser.parse("document.pdf")
+print(result.text)  # rendered Markdown
+```
+
+```
+use liteparse::config::{ImageMode, LiteParseConfig, OutputFormat};
+use liteparse::LiteParse;
+
+
+let config = LiteParseConfig {
+    output_format: OutputFormat::Markdown,
+    image_mode: ImageMode::Placeholder,
+    extract_links: true,
+    ..Default::default()
+};
+let result = LiteParse::new(config).parse("document.pdf").await?;
+println!("{}", result.text); // rendered Markdown
+```
+
+## Quality notes
+
+Markdown reconstruction quality varies with document complexity. LiteParse does a strong job on typical documents, handling prose, headings, simple-to-moderate tables, and lists. This runs entirely locally with no models using rule-based heuristics. For the hardest documents (dense or multi-level tables, complex multi-column layouts, charts, and scans), [LlamaParse](https://developers.llamaindex.ai/python/cloud/llamaparse/?utm_source=github\&utm_medium=liteparse) remains the most accurate option.