diff --git a/README.md b/README.md index 0967119..5ae93e8 100644 --- a/README.md +++ b/README.md @@ -2,27 +2,26 @@ Recognize text using [Calamari OCR](https://github.com/Calamari-OCR/calamari). -Introduction -------------- +## Introduction This offers a OCR-D compliant workspace processor for some of the functionality of Calamari OCR. This processor only operates on the text line level and so needs a line segmentation (and by extension a binarized image) as its input. -Example Usage -------------- +## Example Usage -~~~ +```sh ocrd-calamari-recognize -p test-parameters.json -m mets.xml -I OCR-D-SEG-LINE -O OCR-D-OCR-CALAMARI -~~~ +``` With `test-parameters.json`: -~~~ + +```json { "checkpoint": "/path/to/some/trained/models/*.ckpt.json" } -~~~ +``` TODO ---- diff --git a/setup.py b/setup.py index 4007fff..9ac5d6e 100644 --- a/setup.py +++ b/setup.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -import codecs +from pathlib import Path from setuptools import setup, find_packages @@ -7,13 +7,14 @@ setup( name='ocrd_calamari', version='0.0.1', description='Calamari bindings', - long_description=codecs.open('README.md', encoding='utf-8').read(), + long_description=Path('README.md').read_text(), + long_description_content_type='text/markdown', author='Konstantin Baierer, Mike Gerber', author_email='unixprog@gmail.com, mike.gerber@sbb.spk-berlin.de', url='https://github.com/kba/ocrd_calamari', license='Apache License 2.0', packages=find_packages(exclude=('tests', 'docs')), - install_requires=open('requirements.txt').read().split('\n'), + install_requires=Path('requirements.txt').read_text().split('\n'), package_data={ '': ['*.json', '*.yml', '*.yaml'], },