https://github.com/qurator-spk/dinglehopper

An OCR evaluation tool
https://github.com/qurator-spk/dinglehopper

alto alto-xml ocr ocr-d ocr-evaluation page page-xml qurator

Last synced: 4 months ago
JSON representation

An OCR evaluation tool

• Host: GitHub
• URL: https://github.com/qurator-spk/dinglehopper
• Owner: qurator-spk
• License: apache-2.0
• Created: 2019-08-14T16:04:57.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-01-12T15:19:15.000Z (5 months ago)
• Last Synced: 2024-02-15T08:03:59.190Z (4 months ago)
• Topics: alto, alto-xml, ocr, ocr-d, ocr-evaluation, page, page-xml, qurator
• Language: Python
• Homepage:
• Size: 3.75 MB
• Stars: 51
• Watchers: 5
• Forks: 12
• Open Issues: 31
• Metadata Files:
  • Readme: README-DEV.md
  • License: LICENSE

Lists

• awesome-stars - dinglehopper - spk | 38 | (Python)
• awesome-ocr - dinglehopper - dinglehopper is an OCR evaluation tool and reads ALTO, PAGE and text files. (20. <a name='Benchmarks'></a>Benchmarks / 8.1. <a name='GroundTruth'></a>Ground Truth)
• awesome-ocr - dinglehopper - dinglehopper is an OCR evaluation tool and reads ALTO, PAGE and text files. (Benchmarks / CTPN [paper:2016](https://arxiv.org/pdf/1609.03605.pdf))

README

        
Testing

=======

Use `pytest` to run the tests in [the tests directory](dinglehopper/tests):

```bash

virtualenv -p /usr/bin/python3 venv

. venv/bin/activate

pip install -r requirements.txt

pip install -r requirements-dev.txt

pytest

```

## Test running examples

Only unit tests:

```bash

pytest -m "not integration"

```

Only integration tests:

```bash

pytest -m integration

```

All tests:

```bash

pytest

```

All tests with code coverage:

```bash

pytest --cov=dinglehopper --cov-report=html

```

Static code analysis:

```bash

pytest -k "not test" --mypy

pytest -k "not test" --ruff

```

# How to use pre-commit

This project optionally uses [pre-commit](https://pre-commit.com) to check commits. To use it:

- Install pre-commit, e.g. `pip install -r requirements-dev.txt`

- Install the repo-local git hooks: `pre-commit install`