Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

OCR-D framework

Project description

Collection of OCR-related python tools and wrappers from the OCR-D team
https://img.shields.io/pypi/v/ocrd.svg https://travis-ci.org/OCR-D/core.svg?branch=master https://circleci.com/gh/OCR-D/core.svg?style=svg https://scrutinizer-ci.com/g/OCR-D/core/badges/build.png?b=master Docker Automated build https://codecov.io/gh/OCR-D/core/branch/master/graph/badge.svg https://scrutinizer-ci.com/g/OCR-D/core/badges/quality-score.png?b=master

Installation

To bootstrap the tool, you’ll need installed (Ubuntu packages):

  • Python (python)
  • pip (python-pip)

To install system-wide:

make deps-ubuntu deps install

To develop, install to a virtualenv

pip install virtualenv
virtualenv --no-site-packages venv
source venv/bin/activate
make deps install

Usage

pyocrd installs a binary ocrd that can be used to invoke the processors directly (ocrd process) or start (development) webservices (ocrd server)

TODO: Update docs here.

Examples:

# List available processors
ocrd process

# Region-segment with tesserocr all files in METS INPUT fileGrp
ocrd process -m /path/to/mets.xml segment-region/tesserocr

# Chain multiple processors
ocrd process -m /path/to/mets.xml characterize/exif segment-line/tesserocr recognize/tesserocr

# Start a processor web service at port 6543
ocrd server process -p 6543
http PUT localhost:6543/characterize url==http://server/path/to/mets.xml

Testing

Download assets (make assets)

Test with local files: make test

Test with local asset server:
  • Start asset-server: make asset-server
  • make test OCRD_BASEURL='http://localhost:5001/'
Test with remote assets:
  • make test OCRD_BASEURL='https://github.com/OCR-D/assets/raw/master/data/'

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
ocrd-0.8.7-py2-none-any.whl (130.0 kB) Copy SHA256 hash SHA256 Wheel py2 Oct 23, 2018
ocrd-0.8.7-py3.6.egg (242.5 kB) Copy SHA256 hash SHA256 Egg 3.6 Oct 23, 2018
ocrd-0.8.7-py3-none-any.whl (124.1 kB) Copy SHA256 hash SHA256 Wheel py3 Oct 23, 2018
ocrd-0.8.7.tar.gz (63.6 kB) Copy SHA256 hash SHA256 Source None Oct 23, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page