Skip to main content

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/'

See Also

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

ocrd-0.9.0.tar.gz (64.3 kB view details)

Uploaded Source

Built Distributions

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

ocrd-0.9.0-py3-none-any.whl (125.0 kB view details)

Uploaded Python 3

ocrd-0.9.0-py2-none-any.whl (125.0 kB view details)

Uploaded Python 2

File details

Details for the file ocrd-0.9.0.tar.gz.

File metadata

  • Download URL: ocrd-0.9.0.tar.gz
  • Upload date:
  • Size: 64.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/5.5.1 requests-toolbelt/0.8.0 tqdm/4.23.3 CPython/2.7.9

File hashes

Hashes for ocrd-0.9.0.tar.gz
Algorithm Hash digest
SHA256 d2087801e039c9a877fac299ca610d1e443da426c22f6b19ca2667401dce712f
MD5 cb7d6c3a4edb5c9a6a9c73a3ed5ba357
BLAKE2b-256 24cd01f90dfbb18a8ac66d54277482f011e344e53cc0d87676cf5959178c4924

See more details on using hashes here.

File details

Details for the file ocrd-0.9.0-py3-none-any.whl.

File metadata

  • Download URL: ocrd-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 125.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/5.5.1 requests-toolbelt/0.8.0 tqdm/4.23.3 CPython/2.7.9

File hashes

Hashes for ocrd-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5085f91b6a72bedcf6d7e68c47be30089f6b3d0e248e0db05b2c60d609d8e484
MD5 f0e94e389ae626185667dce7698ae3cf
BLAKE2b-256 b56c2c0e9ec291b57103dfaa7c1a018cb0163018a8b6948260b168cf6cc3feeb

See more details on using hashes here.

File details

Details for the file ocrd-0.9.0-py2-none-any.whl.

File metadata

  • Download URL: ocrd-0.9.0-py2-none-any.whl
  • Upload date:
  • Size: 125.0 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/5.5.1 requests-toolbelt/0.8.0 tqdm/4.23.3 CPython/2.7.9

File hashes

Hashes for ocrd-0.9.0-py2-none-any.whl
Algorithm Hash digest
SHA256 7f1244b225ed71a927d6868840685cd69ca2a2331ecbba22b68f651d4044ba1c
MD5 8b3b70155e5be7017593770dfd632546
BLAKE2b-256 c66a5a9cfbe2d0cb5418d547713c7ef67b980ea99c10b04d1a7a26de4782f29b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page