![logo](resources/logo/calamari_200.png)
[![Python Test](https://github.com/Calamari-OCR/calamari/actions/workflows/python-test.yml/badge.svg)](https://github.com/Calamari-OCR/calamari/actions/workflows/python-test.yml)
[![Upload Python Package](https://github.com/Calamari-OCR/calamari/actions/workflows/python-publish.yml/badge.svg)](https://github.com/Calamari-OCR/calamari/actions/workflows/python-publish.yml)
[![Lint](https://github.com/Calamari-OCR/calamari/actions/workflows/black.yml/badge.svg)](https://github.com/Calamari-OCR/calamari/actions/workflows/black.yml)
OCR Engine based on OCRopy and Kraken using python3.
It is designed to both be easy to use from the command line but also be modular to be integrated and customized from other python scripts.
![preview](resources/preview.png)
## Documentation
The documentation of Calamari is hosted [here](https://calamari-ocr.readthedocs.io).
## Pretrained model repository
Pretrained models are available at (https://github.com/Calamari-OCR/calamari_models).
The current release can be accessed [here](https://github.com/Calamari-OCR/calamari_models/archive/2.0.zip) (255 MB).
## Installing
Calamari is available on [pypi](https://pypi.org/project/calamari-ocr):
```shell
pip install calamari-ocr
```
Read the [docs](https://calamari-ocr.readthedocs.io) for further instructions.
## Command-Line Interface
See the [docs](https://calamari-ocr.readthedocs.io) to learn how to use Calamari from the command line.
## Calamari API
See the [docs](https://calamari-ocr.readthedocs.io) to learn how to adapt Calamari for your needs.
## Citing Calamari
If you use Calamari in your Research-Project, please cite:
> Wick, C., Reul, C., Puppe, F.: *Calamari - A High-Performance Tensorflow-based Deep Learning Package for Optical Character Recognition.* Digital Humanities Quarterly **14**(1) (2020)
```
@article{wick_calamari_2020,
title = {Calamari - {A} {High}-{Performance} {Tensorflow}-based {Deep} {Learning} {Package} for {Optical} {Character} {Recognition}},
volume = {14},
number = {1},
journal = {Digital Humanities Quarterly},
author = {Wick, Christoph and Reul, Christian and Puppe, Frank},
year = {2020},
}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Calamari-OCR/calamari",
"name": "calamari-ocr",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "OCR,optical character recognition,ocropy,ocropus,kraken",
"author": "Christoph Wick",
"author_email": "christoph.wick@informatik.uni-wuerzburg.de",
"download_url": "https://files.pythonhosted.org/packages/29/96/71b03c7c955b0fd718154303c8c6f4b8cba5f4413e3fa3efddedbf765898/calamari_ocr-2.2.2.tar.gz",
"platform": "",
"description": "\n![logo](resources/logo/calamari_200.png)\n\n[![Python Test](https://github.com/Calamari-OCR/calamari/actions/workflows/python-test.yml/badge.svg)](https://github.com/Calamari-OCR/calamari/actions/workflows/python-test.yml)\n[![Upload Python Package](https://github.com/Calamari-OCR/calamari/actions/workflows/python-publish.yml/badge.svg)](https://github.com/Calamari-OCR/calamari/actions/workflows/python-publish.yml)\n[![Lint](https://github.com/Calamari-OCR/calamari/actions/workflows/black.yml/badge.svg)](https://github.com/Calamari-OCR/calamari/actions/workflows/black.yml)\n\nOCR Engine based on OCRopy and Kraken using python3.\nIt is designed to both be easy to use from the command line but also be modular to be integrated and customized from other python scripts.\n\n![preview](resources/preview.png)\n\n## Documentation\n\nThe documentation of Calamari is hosted [here](https://calamari-ocr.readthedocs.io).\n\n## Pretrained model repository\nPretrained models are available at (https://github.com/Calamari-OCR/calamari_models).\nThe current release can be accessed [here](https://github.com/Calamari-OCR/calamari_models/archive/2.0.zip) (255 MB).\n\n## Installing\n\nCalamari is available on [pypi](https://pypi.org/project/calamari-ocr):\n\n```shell\npip install calamari-ocr\n```\n\nRead the [docs](https://calamari-ocr.readthedocs.io) for further instructions.\n\n## Command-Line Interface\n\nSee the [docs](https://calamari-ocr.readthedocs.io) to learn how to use Calamari from the command line.\n\n## Calamari API\n\nSee the [docs](https://calamari-ocr.readthedocs.io) to learn how to adapt Calamari for your needs.\n\n## Citing Calamari\n\nIf you use Calamari in your Research-Project, please cite:\n\n> Wick, C., Reul, C., Puppe, F.: *Calamari - A High-Performance Tensorflow-based Deep Learning Package for Optical Character Recognition.* Digital Humanities Quarterly **14**(1) (2020)\n\n```\n@article{wick_calamari_2020,\n title = {Calamari - {A} {High}-{Performance} {Tensorflow}-based {Deep} {Learning} {Package} for {Optical} {Character} {Recognition}},\n volume = {14},\n number = {1},\n journal = {Digital Humanities Quarterly},\n author = {Wick, Christoph and Reul, Christian and Puppe, Frank},\n year = {2020},\n}\n```\n\n\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "",
"version": "2.2.2",
"project_urls": {
"Download": "https://github.com/Calamari-OCR/calamari/archive/v2.2.2.tar.gz",
"Homepage": "https://github.com/Calamari-OCR/calamari"
},
"split_keywords": [
"ocr",
"optical character recognition",
"ocropy",
"ocropus",
"kraken"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7e0d491659e85b6b21f41eb4df0be23161d54c1a1571661a4e9632b702d06f60",
"md5": "d37dfa4ce9c0ac7eaa9322cb8d2e0142",
"sha256": "ddca68e76cfc9135bcf32b45b0b6574fe0d7a9ac43b4acdf3fa7af83efa67eeb"
},
"downloads": -1,
"filename": "calamari_ocr-2.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d37dfa4ce9c0ac7eaa9322cb8d2e0142",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 198545,
"upload_time": "2022-02-28T18:12:31",
"upload_time_iso_8601": "2022-02-28T18:12:31.558659Z",
"url": "https://files.pythonhosted.org/packages/7e/0d/491659e85b6b21f41eb4df0be23161d54c1a1571661a4e9632b702d06f60/calamari_ocr-2.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "299671b03c7c955b0fd718154303c8c6f4b8cba5f4413e3fa3efddedbf765898",
"md5": "b5ac58df6bcbe608bbdd06e008f54923",
"sha256": "2acff0dad56aa005be91135817de0be2404342c4d41e3d765e04077375833f92"
},
"downloads": -1,
"filename": "calamari_ocr-2.2.2.tar.gz",
"has_sig": false,
"md5_digest": "b5ac58df6bcbe608bbdd06e008f54923",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 126790,
"upload_time": "2022-02-28T18:12:34",
"upload_time_iso_8601": "2022-02-28T18:12:34.733810Z",
"url": "https://files.pythonhosted.org/packages/29/96/71b03c7c955b0fd718154303c8c6f4b8cba5f4413e3fa3efddedbf765898/calamari_ocr-2.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-02-28 18:12:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Calamari-OCR",
"github_project": "calamari",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "edit_distance",
"specs": []
},
{
"name": "h5py",
"specs": []
},
{
"name": "lxml",
"specs": []
},
{
"name": "python-bidi",
"specs": []
},
{
"name": "tensorflow",
"specs": [
[
">=",
"2.4.0"
]
]
},
{
"name": "tfaip",
"specs": [
[
"==",
"1.2.6"
]
]
},
{
"name": "xlsxwriter",
"specs": []
}
],
"lcname": "calamari-ocr"
}