docling-pp-ocrv6 0.1.0__tar.gz

docling_pp_ocrv6-0.1.0/.agent/rules/python.mdc

@@ -0,0 +1,17 @@
+---
+description: Python
+globs: **/*.py
+alwaysApply: false
+---
+
+You have access to context7 to fetch up to date documentation on libraries and frameworks.
+
+
+Execute python code, tests, ruff or linter:
+- Always use uv or make to execute commands.
+- To run python files: `uv run script.py`
+- To run tests: `make test`
+- To run pre-commit: `make check`
+
+Development Guidelines:
+Check the development guidelines here: https://dcc-bs.github.io/documentation/coding/python.html

docling_pp_ocrv6-0.1.0/.github/workflows/main.yml

@@ -0,0 +1,62 @@
+name: Main
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  # ---------------------------------------------------------------------------
+  # Quality checks via DCC-BS reusable workflow (ruff lint + format + ty)
+  # ---------------------------------------------------------------------------
+  quality:
+    uses: DCC-BS/ci-workflows/.github/workflows/python-backend-ci.yml@814649735835a84a3d0d6c8d6e6db87dfeb8b348 # v8
+    with:
+      python_versions: '["3.13"]'
+      quality_python_version: "3.13"
+      check_command: "make check"
+
+  # ---------------------------------------------------------------------------
+  # Tests + coverage
+  # ---------------------------------------------------------------------------
+  tests:
+    name: Tests (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    needs: [quality]
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.13"]
+
+    steps:
+      - uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98 # v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@447e6d02b15d65b3247cce2d6019f11957285d11 # v6
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Run tests with coverage
+        run: uv run pytest --cov --cov-report=xml --junitxml=junit.xml
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@57e3a136b779b570ffcdbf80b3bdc90e7fab3de2 # v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.xml
+      - name: Upload test results to Codecov
+        if: ${{ !cancelled() }}
+        uses: codecov/test-results-action@0fa95f0e1eeaafde2c782583b36b28ad0d8c77d3 # v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./junit.xml

docling_pp_ocrv6-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,45 @@
+name: Publish to PyPI
+
+on:
+  workflow_dispatch:
+
+permissions:
+  id-token: write  # required for PyPI trusted publishing
+  contents: write  # required to push git tags
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98 # v6
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@447e6d02b15d65b3247cce2d6019f11957285d11 # v6
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install 3.13
+
+      - name: Create and push git tag
+        run: |
+          VERSION=$(uv version --short)
+          TAG="v${VERSION}"
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          if git rev-parse "$TAG" >/dev/null 2>&1 || git ls-remote --tags origin | grep -q "refs/tags/$TAG"; then
+            echo "Tag $TAG already exists – skipping"
+          else
+            git tag "$TAG"
+            git push origin "$TAG"
+            echo "Created and pushed tag $TAG"
+          fi
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        run: uv publish

docling_pp_ocrv6-0.1.0/.gitignore

@@ -0,0 +1,57 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+*.egg
+*.egg-info/
+dist/
+build/
+.eggs/
+.installed.cfg
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+MANIFEST
+
+# Virtual environments
+.venv/
+env/
+venv/
+ENV/
+
+
+# Testing & coverage
+.pytest_cache/
+.coverage
+coverage.xml
+htmlcov/
+.tox/
+
+# Type checkers
+.mypy_cache/
+.ruff_cache/
+.ty_cache/
+
+# IDEs
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Distribution
+*.tar.gz
+*.whl
+
+# Environment variables
+.env
+.env.local

docling_pp_ocrv6-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v5.0.0"
+    hooks:
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: check-json
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: detect-private-key
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: "v0.9.9"
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+        types_or: [python, pyi]
+      - id: ruff-format
+        types_or: [python, pyi]

docling_pp_ocrv6-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

docling_pp_ocrv6-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Data Competence Center Basel-Stadt
+
+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.

docling_pp_ocrv6-0.1.0/Makefile

@@ -0,0 +1,56 @@
+.DEFAULT_GOAL := help
+
+.PHONY: help install check lint format type-check test test-xml build clean-build publish
+
+help: ## Display available commands
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n\nTargets:\n"} \
+	/^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 }' $(MAKEFILE_LIST)
+
+# ---------------------------------------------------------------------------
+# Setup
+# ---------------------------------------------------------------------------
+
+install: ## Install dependencies and pre-commit hooks (CPU onnxruntime)
+	uv sync --extra cpu --dev
+	uv run pre-commit install
+
+# ---------------------------------------------------------------------------
+# Quality checks
+# ---------------------------------------------------------------------------
+
+lint: ## Run ruff linter (with auto-fix)
+	uv run ruff check . --fix
+
+format: ## Run ruff formatter
+	uv run ruff format .
+
+type-check: ## Run ty type checker
+	uv run ty check src/
+
+check: ## Run all quality checks (lint, format check, type check)
+	uv run ruff check .
+	uv run ruff format --check .
+	uv run ty check src/
+
+# ---------------------------------------------------------------------------
+# Tests
+# ---------------------------------------------------------------------------
+
+test: ## Run tests with terminal coverage report
+	uv run pytest
+
+test-xml: ## Run tests and produce XML coverage report only
+	uv run pytest --cov-report=xml --cov-report=
+
+# ---------------------------------------------------------------------------
+# Build & publish
+# ---------------------------------------------------------------------------
+
+build: clean-build ## Build distribution packages
+	uv build
+
+clean-build: ## Remove build artefacts
+	rm -rf dist/ build/ *.egg-info
+
+publish: build ## Publish package to PyPI
+	uv publish

docling_pp_ocrv6-0.1.0/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: docling-pp-ocrv6
+Version: 0.1.0
+Summary: A docling OCR plugin for PaddlePaddle PP-OCRv6 (ONNX via RapidOCR)
+Project-URL: Homepage, https://github.com/DCC-BS/docling-pp-ocrv6
+Project-URL: Repository, https://github.com/DCC-BS/docling-pp-ocrv6
+Project-URL: Issues, https://github.com/DCC-BS/docling-pp-ocrv6/issues
+Project-URL: Changelog, https://github.com/DCC-BS/docling-pp-ocrv6/releases
+Author-email: Yanick Schraner <yanick.schraner@bs.ch>, Tobias Bollinger <tobias.bollinger@bs.ch>
+License: MIT
+License-File: LICENSE
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: docling>=2.73
+Requires-Dist: huggingface-hub>=1.3.0
+Requires-Dist: numpy
+Requires-Dist: pillow>=10.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rapidocr>=3.0
+Provides-Extra: cpu
+Requires-Dist: onnxruntime>=1.17; extra == 'cpu'
+Provides-Extra: gpu
+Requires-Dist: onnxruntime-gpu>=1.17; extra == 'gpu'
+Description-Content-Type: text/markdown
+
+# docling-pp-ocrv6
+
+A [Docling](https://github.com/docling-project/docling) OCR plugin for
+PaddlePaddle's **PP-OCRv6** models. It runs the PP-OCRv6 detection and
+recognition **ONNX** checkpoints locally through
+[RapidOCR](https://github.com/RapidAI/RapidOCR) (onnxruntime), so OCR happens
+inside the docling worker — no external service required.
+
+GPU acceleration is automatic when the docling accelerator device resolves to
+CUDA and `onnxruntime-gpu` is installed.
+
+## Installation
+
+Pick exactly one onnxruntime extra — installing both the CPU and GPU wheels at
+once is unsupported and prevents the CUDA provider from registering:
+
+```bash
+pip install "docling-pp-ocrv6[cpu]"     # CPU (onnxruntime)
+pip install "docling-pp-ocrv6[gpu]"     # CUDA (onnxruntime-gpu)
+```
+
+The detection and recognition ONNX models are downloaded from HuggingFace on
+first use and cached under docling's model cache. To pre-fetch them (e.g. at
+container build time):
+
+```python
+from docling_pp_ocrv6 import PPOCRv6Model
+PPOCRv6Model.download_models()
+```
+
+## Usage
+
+```python
+from docling.document_converter import DocumentConverter, PdfFormatOption
+from docling.datamodel.base_models import InputFormat
+from docling.datamodel.pipeline_options import PdfPipelineOptions
+from docling_pp_ocrv6 import PPOCRv6Options
+
+pipeline_options = PdfPipelineOptions(do_ocr=True)
+pipeline_options.ocr_options = PPOCRv6Options()
+
+converter = DocumentConverter(
+    format_options={InputFormat.PDF: PdfFormatOption(pipeline_options=pipeline_options)}
+)
+result = converter.convert("scanned.pdf")
+print(result.document.export_to_markdown())
+```
+
+With **docling-serve**, request the engine by its `kind`:
+
+```json
+{ "options": { "ocr": true, "ocr_engine": "pp-ocrv6" } }
+```
+
+(`DOCLING_SERVE_ALLOW_EXTERNAL_PLUGINS=true` must be set for the plugin to load.)
+
+## Configuration
+
+All options are settable via `PPOCRv6Options(...)` or environment variables:
+
+| Option | Env var | Default |
+| --- | --- | --- |
+| `lang` | `PPOCRV6_LANG` | `de,en,fr,it,es,nl,pt,...` (German-led European set) |
+| `text_score` | `PPOCRV6_TEXT_SCORE` | `0.5` |
+| `use_det` / `use_cls` / `use_rec` | `PPOCRV6_USE_DET` / `_CLS` / `_REC` | `true` |
+| `det_repo` | `PPOCRV6_DET_REPO` | `PaddlePaddle/PP-OCRv6_medium_det_onnx` |
+| `rec_repo` | `PPOCRV6_REC_REPO` | `PaddlePaddle/PP-OCRv6_medium_rec_onnx` |
+| `det_model_path` / `rec_model_path` / `rec_keys_path` / `cls_model_path` | `PPOCRV6_*_MODEL_PATH` / `_KEYS_PATH` | auto |
+
+The recognition character dictionary is extracted automatically from the
+recognition model's `inference.yml`. Angle classification uses RapidOCR's
+bundled cls model unless `cls_model_path` is set.
+
+## Development
+
+```bash
+make install   # uv sync + pre-commit
+make check     # ruff lint + format check + ty type check
+make test      # pytest with coverage
+```
+
+## License
+
+MIT

docling_pp_ocrv6-0.1.0/README.md

@@ -0,0 +1,84 @@
+# docling-pp-ocrv6
+
+A [Docling](https://github.com/docling-project/docling) OCR plugin for
+PaddlePaddle's **PP-OCRv6** models. It runs the PP-OCRv6 detection and
+recognition **ONNX** checkpoints locally through
+[RapidOCR](https://github.com/RapidAI/RapidOCR) (onnxruntime), so OCR happens
+inside the docling worker — no external service required.
+
+GPU acceleration is automatic when the docling accelerator device resolves to
+CUDA and `onnxruntime-gpu` is installed.
+
+## Installation
+
+Pick exactly one onnxruntime extra — installing both the CPU and GPU wheels at
+once is unsupported and prevents the CUDA provider from registering:
+
+```bash
+pip install "docling-pp-ocrv6[cpu]"     # CPU (onnxruntime)
+pip install "docling-pp-ocrv6[gpu]"     # CUDA (onnxruntime-gpu)
+```
+
+The detection and recognition ONNX models are downloaded from HuggingFace on
+first use and cached under docling's model cache. To pre-fetch them (e.g. at
+container build time):
+
+```python
+from docling_pp_ocrv6 import PPOCRv6Model
+PPOCRv6Model.download_models()
+```
+
+## Usage
+
+```python
+from docling.document_converter import DocumentConverter, PdfFormatOption
+from docling.datamodel.base_models import InputFormat
+from docling.datamodel.pipeline_options import PdfPipelineOptions
+from docling_pp_ocrv6 import PPOCRv6Options
+
+pipeline_options = PdfPipelineOptions(do_ocr=True)
+pipeline_options.ocr_options = PPOCRv6Options()
+
+converter = DocumentConverter(
+    format_options={InputFormat.PDF: PdfFormatOption(pipeline_options=pipeline_options)}
+)
+result = converter.convert("scanned.pdf")
+print(result.document.export_to_markdown())
+```
+
+With **docling-serve**, request the engine by its `kind`:
+
+```json
+{ "options": { "ocr": true, "ocr_engine": "pp-ocrv6" } }
+```
+
+(`DOCLING_SERVE_ALLOW_EXTERNAL_PLUGINS=true` must be set for the plugin to load.)
+
+## Configuration
+
+All options are settable via `PPOCRv6Options(...)` or environment variables:
+
+| Option | Env var | Default |
+| --- | --- | --- |
+| `lang` | `PPOCRV6_LANG` | `de,en,fr,it,es,nl,pt,...` (German-led European set) |
+| `text_score` | `PPOCRV6_TEXT_SCORE` | `0.5` |
+| `use_det` / `use_cls` / `use_rec` | `PPOCRV6_USE_DET` / `_CLS` / `_REC` | `true` |
+| `det_repo` | `PPOCRV6_DET_REPO` | `PaddlePaddle/PP-OCRv6_medium_det_onnx` |
+| `rec_repo` | `PPOCRV6_REC_REPO` | `PaddlePaddle/PP-OCRv6_medium_rec_onnx` |
+| `det_model_path` / `rec_model_path` / `rec_keys_path` / `cls_model_path` | `PPOCRV6_*_MODEL_PATH` / `_KEYS_PATH` | auto |
+
+The recognition character dictionary is extracted automatically from the
+recognition model's `inference.yml`. Angle classification uses RapidOCR's
+bundled cls model unless `cls_model_path` is set.
+
+## Development
+
+```bash
+make install   # uv sync + pre-commit
+make check     # ruff lint + format check + ty type check
+make test      # pytest with coverage
+```
+
+## License
+
+MIT

docling_pp_ocrv6-0.1.0/codecov.yml

@@ -0,0 +1,15 @@
+coverage:
+  status:
+    project:
+      default:
+        target: 80%
+        threshold: 2%
+    patch:
+      default:
+        target: 80%
+        threshold: 5%
+
+comment:
+  layout: "reach, diff, flags, files"
+  behavior: default
+  require_changes: false

docling_pp_ocrv6-0.1.0/pyproject.toml

@@ -0,0 +1,166 @@
+[project]
+name = "docling-pp-ocrv6"
+version = "0.1.0"
+description = "A docling OCR plugin for PaddlePaddle PP-OCRv6 (ONNX via RapidOCR)"
+authors = [
+    {name = "Yanick Schraner", email = "yanick.schraner@bs.ch"},
+    {name = "Tobias Bollinger", email = "tobias.bollinger@bs.ch"},
+]
+requires-python = ">=3.12"
+license = {text = "MIT"}
+readme = "README.md"
+keywords = []
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+
+    "License :: OSI Approved :: MIT License",
+
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+    "Typing :: Typed",
+]
+dependencies = [
+    "docling>=2.73",
+    "rapidocr>=3.0",
+    "huggingface-hub>=1.3.0",
+    "pyyaml>=6.0",
+    "numpy",
+    "pillow>=10.0",
+]
+
+[project.optional-dependencies]
+# onnxruntime is intentionally NOT a base dependency: installing both the CPU
+# and GPU wheels at once is unsupported and makes the CUDA provider fail to
+# register. Pick exactly one extra.
+cpu = ["onnxruntime>=1.17"]
+gpu = ["onnxruntime-gpu>=1.17"]
+
+[project.entry-points."docling"]
+docling_pp_ocrv6 = "docling_pp_ocrv6.plugin"
+
+[project.urls]
+Homepage = "https://github.com/DCC-BS/docling-pp-ocrv6"
+Repository = "https://github.com/DCC-BS/docling-pp-ocrv6"
+Issues = "https://github.com/DCC-BS/docling-pp-ocrv6/issues"
+Changelog = "https://github.com/DCC-BS/docling-pp-ocrv6/releases"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-cov>=6.0.0",
+    "ruff>=0.9.0",
+    "ty>=0.0.9",
+    "pre-commit>=4.5.1",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/docling_pp_ocrv6"]
+
+[tool.ruff]
+target-version = "py313"
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+    "A",    # flake8-builtins
+    "ANN",  # flake8-annotations
+    "ARG",  # flake8-unused-arguments
+    "B",    # flake8-bugbear
+    "BLE",  # flake8-blind-except
+    "C4",   # flake8-comprehensions
+    "C90",  # mccabe complexity
+    "COM",  # flake8-commas
+    "D",    # pydocstyle
+    "DTZ",  # flake8-datetimez
+    "E",    # pycodestyle errors
+    "EM",   # flake8-errmsg
+    "ERA",  # eradicate
+    "F",    # pyflakes
+    "FBT",  # flake8-boolean-trap
+    "I",    # isort
+    "ICN",  # flake8-import-conventions
+    "ISC",  # flake8-implicit-str-concat
+    "N",    # pep8-naming
+    "PD",   # pandas-vet
+    "PGH",  # pygrep-hooks
+    "PIE",  # flake8-pie
+    "PL",   # pylint
+    "PT",   # flake8-pytest-style
+    "PTH",  # flake8-use-pathlib
+    "PYI",  # flake8-pyi
+    "Q",    # flake8-quotes
+    "RET",  # flake8-return
+    "RSE",  # flake8-raise
+    "RUF",  # ruff-specific
+    "S",    # flake8-bandit
+    "SIM",  # flake8-simplify
+    "SLF",  # flake8-self
+    "T20",  # flake8-print
+    "TCH",  # flake8-type-checking
+    "TID",  # flake8-tidy-imports
+    "TRY",  # tryceratops
+    "UP",   # pyupgrade
+    "W",    # pycodestyle warnings
+    "YTT",  # flake8-2020
+]
+ignore = [
+    "COM812",  # trailing comma – conflicts with formatter
+    "D100",    # missing docstring in public module
+    "D104",    # missing docstring in public package
+    "D107",    # missing docstring in __init__
+    "D203",    # one-blank-line-before-class (conflicts with D211)
+    "D213",    # multi-line-summary-second-line (conflicts with D212)
+    "ISC001",  # implicit string concat – conflicts with formatter
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["S101", "D", "ANN", "ARG", "SLF", "PLC0415", "PLR2004"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.format]
+preview = true
+indent-style = "space"
+quote-style = "double"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[tool.ty.environment]
+python-version = "3.13"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = [
+    "--cov=src/docling_pp_ocrv6",
+    "--cov-report=term-missing",
+    "--cov-report=xml",
+    "-v",
+]
+markers = [
+    "e2e: end-to-end tests requiring the PP-OCRv6 ONNX models (downloads from HuggingFace)",
+]
+
+[tool.coverage.run]
+source = ["src/docling_pp_ocrv6"]
+branch = true
+omit = ["tests/*", ".venv/*"]
+
+[tool.coverage.report]
+show_missing = true
+fail_under = 80
+exclude_lines = [
+    "pragma: no cover",
+    "if TYPE_CHECKING:",
+    "raise NotImplementedError",
+    "@(abc\\.)?abstractmethod",
+]
+
+[tool.uv]
+exclude-newer = "1 week"
+exclude-newer-package = { dcc-backend-common = "P1D" }