OCR Bridge Core

Core interfaces and utilities for OCR Bridge engine packages.

Overview

ocrbridge-core provides the foundational abstract base classes, models, and utilities that all OCR engine packages must implement. This package enables a modular, plugin-based architecture where OCR engines can be dynamically discovered and loaded at runtime.

Installation

pip install ocrbridge-core

For local development, we recommend using uv and the provided Makefile.

See CONTRIBUTING.md for detailed setup instructions.

# Quick start (requires uv)
make install
make check

Core Components

OCREngine Base Class

All OCR engines must inherit from OCREngine and implement:

process(file_path, params) - Process a document and return HOCR XML
name property - Engine identifier (e.g., 'tesseract', 'easyocr')
supported_formats property - Set of supported file extensions

OCREngineParams

Base model for engine-specific parameters using Pydantic validation.

Exceptions

OCRBridgeError - Base exception
OCRProcessingError - Processing failures
UnsupportedFormatError - Unsupported file format
EngineNotAvailableError - Engine not installed/available
InvalidParametersError - Invalid parameters

HOCR Utilities

Helper functions for HOCR XML parsing, validation, and conversion:

parse_hocr() - Parse and extract HOCR information
validate_hocr() - Validate HOCR structure
extract_bbox() - Extract bounding box coordinates
easyocr_to_hocr() - Convert EasyOCR results to HOCR format

Implementing a New Engine

See the engine packages for examples:

ocrbridge-tesseract - Simple reference implementation
ocrbridge-easyocr - Deep learning with GPU support
ocrbridge-ocrmac - Platform-specific (macOS only)

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ocrbridge_core-3.1.1.tar.gz (104.6 kB view details)

Uploaded Dec 31, 2025 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

ocrbridge_core-3.1.1-py3-none-any.whl (11.5 kB view details)

Uploaded Dec 31, 2025 Python 3

File details

Details for the file ocrbridge_core-3.1.1.tar.gz.

File metadata

Download URL: ocrbridge_core-3.1.1.tar.gz
Upload date: Dec 31, 2025
Size: 104.6 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ocrbridge_core-3.1.1.tar.gz
Algorithm	Hash digest
SHA256	`bd7601b38314b6d6d686d6f779764a0931e9e9279c311a2ee6a758eca876d572`
MD5	`05f86df33f5ebf1d9a4f9510ed75b7f7`
BLAKE2b-256	`b3d1405e30f8a41dc1c4b998c3a2f6fd5d5630d7c60933f049a00ad42d538448`

See more details on using hashes here.

Provenance

The following attestation bundles were made for ocrbridge_core-3.1.1.tar.gz:

Publisher: release.yml on OCRBridge/ocrbridge-core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: ocrbridge_core-3.1.1.tar.gz
- Subject digest: bd7601b38314b6d6d686d6f779764a0931e9e9279c311a2ee6a758eca876d572
- Sigstore transparency entry: 784812438
- Sigstore integration time: Dec 31, 2025
Source repository:
- Permalink: OCRBridge/ocrbridge-core@3c7e7c9d7f62e9444b73fb3d5a5066cdfda5ae69
- Branch / Tag: refs/heads/main
- Owner: https://github.com/OCRBridge
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@3c7e7c9d7f62e9444b73fb3d5a5066cdfda5ae69
- Trigger Event: push