Python Tesseract
================
.. image:: https://img.shields.io/pypi/pyversions/pytesseract.svg
:target: https://pypi.python.org/pypi/pytesseract
:alt: Python versions
.. image:: https://img.shields.io/github/release/madmaze/pytesseract.svg
:target: https://github.com/madmaze/pytesseract/releases
:alt: Github release
.. image:: https://img.shields.io/pypi/v/pytesseract.svg?color=blue
:target: https://pypi.python.org/pypi/pytesseract
:alt: PyPI release
.. image:: https://img.shields.io/conda/vn/conda-forge/pytesseract.svg?color=blue
:target: https://anaconda.org/conda-forge/pytesseract
:alt: Conda release
.. image:: https://results.pre-commit.ci/badge/github/madmaze/pytesseract/master.svg
:target: https://results.pre-commit.ci/latest/github/madmaze/pytesseract/master
:alt: Pre-commit CI status
.. image:: https://github.com/madmaze/pytesseract/workflows/CI/badge.svg?branch=master
:target: https://github.com/madmaze/pytesseract/actions?query=workflow%3ACI
:alt: CI workflow status
Python-tesseract is an optical character recognition (OCR) tool for python.
That is, it will recognize and "read" the text embedded in images.
Python-tesseract is a wrapper for `Google's Tesseract-OCR Engine <https://github.com/tesseract-ocr/tesseract>`_.
It is also useful as a stand-alone invocation script to tesseract, as it can read all image types
supported by the Pillow and Leptonica imaging libraries, including jpeg, png, gif, bmp, tiff,
and others. Additionally, if used as a script, Python-tesseract will print the recognized
text instead of writing it to a file.
USAGE
-----
**Quickstart**
*Note*: Test images are located in the ``tests/data`` folder of the Git repo.
Library usage:
.. code-block:: python
from PIL import Image
import pytesseract
# If you don't have tesseract executable in your PATH, include the following:
pytesseract.pytesseract.tesseract_cmd = r'<full_path_to_your_tesseract_executable>'
# Example tesseract_cmd = r'C:\Program Files (x86)\Tesseract-OCR\tesseract'
# Simple image to string
print(pytesseract.image_to_string(Image.open('test.png')))
# In order to bypass the image conversions of pytesseract, just use relative or absolute image path
# NOTE: In this case you should provide tesseract supported images or tesseract will return error
print(pytesseract.image_to_string('test.png'))
# List of available languages
print(pytesseract.get_languages(config=''))
# French text image to string
print(pytesseract.image_to_string(Image.open('test-european.jpg'), lang='fra'))
# Batch processing with a single file containing the list of multiple image file paths
print(pytesseract.image_to_string('images.txt'))
# Timeout/terminate the tesseract job after a period of time
try:
print(pytesseract.image_to_string('test.jpg', timeout=2)) # Timeout after 2 seconds
print(pytesseract.image_to_string('test.jpg', timeout=0.5)) # Timeout after half a second
except RuntimeError as timeout_error:
# Tesseract processing is terminated
pass
# Get bounding box estimates
print(pytesseract.image_to_boxes(Image.open('test.png')))
# Get verbose data including boxes, confidences, line and page numbers
print(pytesseract.image_to_data(Image.open('test.png')))
# Get information about orientation and script detection
print(pytesseract.image_to_osd(Image.open('test.png')))
# Get a searchable PDF
pdf = pytesseract.image_to_pdf_or_hocr('test.png', extension='pdf')
with open('test.pdf', 'w+b') as f:
f.write(pdf) # pdf type is bytes by default
# Get HOCR output
hocr = pytesseract.image_to_pdf_or_hocr('test.png', extension='hocr')
# Get ALTO XML output
xml = pytesseract.image_to_alto_xml('test.png')
# getting multiple types of output with one call to save compute time
# currently supports mix and match of the following: txt, pdf, hocr, box, tsv
text, boxes = pytesseract.run_and_get_multiple_output('test.png', extensions=['txt', 'box'])
Support for OpenCV image/NumPy array objects
.. code-block:: python
import cv2
img_cv = cv2.imread(r'/<path_to_image>/digits.png')
# By default OpenCV stores images in BGR format and since pytesseract assumes RGB format,
# we need to convert from BGR to RGB format/mode:
img_rgb = cv2.cvtColor(img_cv, cv2.COLOR_BGR2RGB)
print(pytesseract.image_to_string(img_rgb))
# OR
img_rgb = Image.frombytes('RGB', img_cv.shape[:2], img_cv, 'raw', 'BGR', 0, 0)
print(pytesseract.image_to_string(img_rgb))
If you need custom configuration like `oem`/`psm`, use the **config** keyword.
.. code-block:: python
# Example of adding any additional options
custom_oem_psm_config = r'--oem 3 --psm 6'
pytesseract.image_to_string(image, config=custom_oem_psm_config)
# Example of using pre-defined tesseract config file with options
cfg_filename = 'words'
pytesseract.run_and_get_output(image, extension='txt', config=cfg_filename)
Add the following config, if you have tessdata error like: "Error opening data file..."
.. code-block:: python
# Example config: r'--tessdata-dir "C:\Program Files (x86)\Tesseract-OCR\tessdata"'
# It's important to add double quotes around the dir path.
tessdata_dir_config = r'--tessdata-dir "<replace_with_your_tessdata_dir_path>"'
pytesseract.image_to_string(image, lang='chi_sim', config=tessdata_dir_config)
**Functions**
* **get_languages** Returns all currently supported languages by Tesseract OCR.
* **get_tesseract_version** Returns the Tesseract version installed in the system.
* **image_to_string** Returns unmodified output as string from Tesseract OCR processing
* **image_to_boxes** Returns result containing recognized characters and their box boundaries
* **image_to_data** Returns result containing box boundaries, confidences, and other information. Requires Tesseract 3.05+. For more information, please check the `Tesseract TSV documentation <https://tesseract-ocr.github.io/tessdoc/Command-Line-Usage.html>`_
* **image_to_osd** Returns result containing information about orientation and script detection.
* **image_to_alto_xml** Returns result in the form of Tesseract's ALTO XML format.
* **run_and_get_output** Returns the raw output from Tesseract OCR. Gives a bit more control over the parameters that are sent to tesseract.
* **run_and_get_multiple_output** Returns like `run_and_get_output` but can handle multiple extensions. This function replaces the `extension: str` kwarg with `extension: List[str]` kwarg where a list of extensions can be specified and the corresponding data is returned after only one `tesseract` call. This function reduces the number of calls to `tesseract` when multiple output formats, like both text and bounding boxes, are needed.
**Parameters**
``image_to_data(image, lang=None, config='', nice=0, output_type=Output.STRING, timeout=0, pandas_config=None)``
* **image** Object or String - either PIL Image, NumPy array or file path of the image to be processed by Tesseract. If you pass object instead of file path, pytesseract will implicitly convert the image to `RGB mode <https://pillow.readthedocs.io/en/stable/handbook/concepts.html#modes>`_.
* **lang** String - Tesseract language code string. Defaults to ``eng`` if not specified! Example for multiple languages: ``lang='eng+fra'``
* **config** String - Any **additional custom configuration flags** that are not available via the pytesseract function. For example: ``config='--psm 6'``
* **nice** Integer - modifies the processor priority for the Tesseract run. Not supported on Windows. Nice adjusts the niceness of unix-like processes.
* **output_type** Class attribute - specifies the type of the output, defaults to ``string``. For the full list of all supported types, please check the definition of `pytesseract.Output <https://github.com/madmaze/pytesseract/blob/master/pytesseract/pytesseract.py>`_ class.
* **timeout** Integer or Float - duration in seconds for the OCR processing, after which, pytesseract will terminate and raise RuntimeError.
* **pandas_config** Dict - only for the **Output.DATAFRAME** type. Dictionary with custom arguments for `pandas.read_csv <https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.read_csv.html#pandas-read-csv>`_. Allows you to customize the output of **image_to_data**.
CLI usage:
.. code-block:: bash
pytesseract [-l lang] image_file
INSTALLATION
------------
Prerequisites:
- Python-tesseract requires Python 3.6+
- You will need the Python Imaging Library (PIL) (or the `Pillow <https://pypi.org/project/Pillow/>`_ fork).
Please check the `Pillow documentation <https://pillow.readthedocs.io/en/stable/installation.html#basic-installation>`_ to know the basic Pillow installation.
- Install `Google Tesseract OCR <https://github.com/tesseract-ocr/tesseract>`_
(additional info how to install the engine on Linux, Mac OSX and Windows).
You must be able to invoke the tesseract command as *tesseract*. If this
isn't the case, for example because tesseract isn't in your PATH, you will
have to change the "tesseract_cmd" variable ``pytesseract.pytesseract.tesseract_cmd``.
Under Debian/Ubuntu you can use the package **tesseract-ocr**.
For Mac OS users. please install homebrew package **tesseract**.
*Note:* In some rare cases, you might need to additionally install ``tessconfigs`` and ``configs`` from `tesseract-ocr/tessconfigs <https://github.com/tesseract-ocr/tessconfigs>`_ if the OS specific package doesn't include them.
| Installing via pip:
Check the `pytesseract package page <https://pypi.python.org/pypi/pytesseract>`_ for more information.
.. code-block:: bash
pip install pytesseract
| Or if you have git installed:
.. code-block:: bash
pip install -U git+https://github.com/madmaze/pytesseract.git
| Installing from source:
.. code-block:: bash
git clone https://github.com/madmaze/pytesseract.git
cd pytesseract && pip install -U .
| Install with conda (via `conda-forge <https://anaconda.org/conda-forge/pytesseract>`_):
.. code-block:: bash
conda install -c conda-forge pytesseract
TESTING
-------
To run this project's test suite, install and run ``tox``. Ensure that you have ``tesseract``
installed and in your PATH.
.. code-block:: bash
pip install tox
tox
LICENSE
-------
Check the LICENSE file included in the Python-tesseract repository/distribution.
As of Python-tesseract 0.3.1 the license is Apache License Version 2.0
CONTRIBUTORS
------------
- Originally written by `Samuel Hoffstaetter <https://github.com/h>`_
- `Full list of contributors <https://github.com/madmaze/pytesseract/graphs/contributors>`_
Raw data
{
"_id": null,
"home_page": "https://github.com/madmaze/pytesseract",
"name": "pytesseract",
"maintainer": "Matthias Lee",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "pytesseract@madmaze.net",
"keywords": "python-tesseract OCR Python",
"author": "Samuel Hoffstaetter",
"author_email": "samuel@hoffstaetter.com",
"download_url": "https://files.pythonhosted.org/packages/9f/a6/7d679b83c285974a7cb94d739b461fa7e7a9b17a3abfd7bf6cbc5c2394b0/pytesseract-0.3.13.tar.gz",
"platform": null,
"description": "Python Tesseract\n================\n\n.. image:: https://img.shields.io/pypi/pyversions/pytesseract.svg\n :target: https://pypi.python.org/pypi/pytesseract\n :alt: Python versions\n\n.. image:: \thttps://img.shields.io/github/release/madmaze/pytesseract.svg\n :target: https://github.com/madmaze/pytesseract/releases\n :alt: Github release\n\n.. image:: https://img.shields.io/pypi/v/pytesseract.svg?color=blue\n :target: https://pypi.python.org/pypi/pytesseract\n :alt: PyPI release\n\n.. image:: https://img.shields.io/conda/vn/conda-forge/pytesseract.svg?color=blue\n :target: https://anaconda.org/conda-forge/pytesseract\n :alt: Conda release\n\n.. image:: https://results.pre-commit.ci/badge/github/madmaze/pytesseract/master.svg\n :target: https://results.pre-commit.ci/latest/github/madmaze/pytesseract/master\n :alt: Pre-commit CI status\n\n.. image:: https://github.com/madmaze/pytesseract/workflows/CI/badge.svg?branch=master\n :target: https://github.com/madmaze/pytesseract/actions?query=workflow%3ACI\n :alt: CI workflow status\n\nPython-tesseract is an optical character recognition (OCR) tool for python.\nThat is, it will recognize and \"read\" the text embedded in images.\n\nPython-tesseract is a wrapper for `Google's Tesseract-OCR Engine <https://github.com/tesseract-ocr/tesseract>`_.\nIt is also useful as a stand-alone invocation script to tesseract, as it can read all image types\nsupported by the Pillow and Leptonica imaging libraries, including jpeg, png, gif, bmp, tiff,\nand others. Additionally, if used as a script, Python-tesseract will print the recognized\ntext instead of writing it to a file.\n\nUSAGE\n-----\n\n**Quickstart**\n\n*Note*: Test images are located in the ``tests/data`` folder of the Git repo.\n\nLibrary usage:\n\n.. code-block:: python\n\n from PIL import Image\n\n import pytesseract\n\n # If you don't have tesseract executable in your PATH, include the following:\n pytesseract.pytesseract.tesseract_cmd = r'<full_path_to_your_tesseract_executable>'\n # Example tesseract_cmd = r'C:\\Program Files (x86)\\Tesseract-OCR\\tesseract'\n\n # Simple image to string\n print(pytesseract.image_to_string(Image.open('test.png')))\n\n # In order to bypass the image conversions of pytesseract, just use relative or absolute image path\n # NOTE: In this case you should provide tesseract supported images or tesseract will return error\n print(pytesseract.image_to_string('test.png'))\n\n # List of available languages\n print(pytesseract.get_languages(config=''))\n\n # French text image to string\n print(pytesseract.image_to_string(Image.open('test-european.jpg'), lang='fra'))\n\n # Batch processing with a single file containing the list of multiple image file paths\n print(pytesseract.image_to_string('images.txt'))\n\n # Timeout/terminate the tesseract job after a period of time\n try:\n print(pytesseract.image_to_string('test.jpg', timeout=2)) # Timeout after 2 seconds\n print(pytesseract.image_to_string('test.jpg', timeout=0.5)) # Timeout after half a second\n except RuntimeError as timeout_error:\n # Tesseract processing is terminated\n pass\n\n # Get bounding box estimates\n print(pytesseract.image_to_boxes(Image.open('test.png')))\n\n # Get verbose data including boxes, confidences, line and page numbers\n print(pytesseract.image_to_data(Image.open('test.png')))\n\n # Get information about orientation and script detection\n print(pytesseract.image_to_osd(Image.open('test.png')))\n\n # Get a searchable PDF\n pdf = pytesseract.image_to_pdf_or_hocr('test.png', extension='pdf')\n with open('test.pdf', 'w+b') as f:\n f.write(pdf) # pdf type is bytes by default\n\n # Get HOCR output\n hocr = pytesseract.image_to_pdf_or_hocr('test.png', extension='hocr')\n\n # Get ALTO XML output\n xml = pytesseract.image_to_alto_xml('test.png')\n\n # getting multiple types of output with one call to save compute time\n # currently supports mix and match of the following: txt, pdf, hocr, box, tsv\n text, boxes = pytesseract.run_and_get_multiple_output('test.png', extensions=['txt', 'box'])\n\nSupport for OpenCV image/NumPy array objects\n\n.. code-block:: python\n\n import cv2\n\n img_cv = cv2.imread(r'/<path_to_image>/digits.png')\n\n # By default OpenCV stores images in BGR format and since pytesseract assumes RGB format,\n # we need to convert from BGR to RGB format/mode:\n img_rgb = cv2.cvtColor(img_cv, cv2.COLOR_BGR2RGB)\n print(pytesseract.image_to_string(img_rgb))\n # OR\n img_rgb = Image.frombytes('RGB', img_cv.shape[:2], img_cv, 'raw', 'BGR', 0, 0)\n print(pytesseract.image_to_string(img_rgb))\n\n\nIf you need custom configuration like `oem`/`psm`, use the **config** keyword.\n\n.. code-block:: python\n\n # Example of adding any additional options\n custom_oem_psm_config = r'--oem 3 --psm 6'\n pytesseract.image_to_string(image, config=custom_oem_psm_config)\n\n # Example of using pre-defined tesseract config file with options\n cfg_filename = 'words'\n pytesseract.run_and_get_output(image, extension='txt', config=cfg_filename)\n\nAdd the following config, if you have tessdata error like: \"Error opening data file...\"\n\n.. code-block:: python\n\n # Example config: r'--tessdata-dir \"C:\\Program Files (x86)\\Tesseract-OCR\\tessdata\"'\n # It's important to add double quotes around the dir path.\n tessdata_dir_config = r'--tessdata-dir \"<replace_with_your_tessdata_dir_path>\"'\n pytesseract.image_to_string(image, lang='chi_sim', config=tessdata_dir_config)\n\n**Functions**\n\n* **get_languages** Returns all currently supported languages by Tesseract OCR.\n\n* **get_tesseract_version** Returns the Tesseract version installed in the system.\n\n* **image_to_string** Returns unmodified output as string from Tesseract OCR processing\n\n* **image_to_boxes** Returns result containing recognized characters and their box boundaries\n\n* **image_to_data** Returns result containing box boundaries, confidences, and other information. Requires Tesseract 3.05+. For more information, please check the `Tesseract TSV documentation <https://tesseract-ocr.github.io/tessdoc/Command-Line-Usage.html>`_\n\n* **image_to_osd** Returns result containing information about orientation and script detection.\n\n* **image_to_alto_xml** Returns result in the form of Tesseract's ALTO XML format.\n\n* **run_and_get_output** Returns the raw output from Tesseract OCR. Gives a bit more control over the parameters that are sent to tesseract.\n\n* **run_and_get_multiple_output** Returns like `run_and_get_output` but can handle multiple extensions. This function replaces the `extension: str` kwarg with `extension: List[str]` kwarg where a list of extensions can be specified and the corresponding data is returned after only one `tesseract` call. This function reduces the number of calls to `tesseract` when multiple output formats, like both text and bounding boxes, are needed.\n\n**Parameters**\n\n``image_to_data(image, lang=None, config='', nice=0, output_type=Output.STRING, timeout=0, pandas_config=None)``\n\n* **image** Object or String - either PIL Image, NumPy array or file path of the image to be processed by Tesseract. If you pass object instead of file path, pytesseract will implicitly convert the image to `RGB mode <https://pillow.readthedocs.io/en/stable/handbook/concepts.html#modes>`_.\n\n* **lang** String - Tesseract language code string. Defaults to ``eng`` if not specified! Example for multiple languages: ``lang='eng+fra'``\n\n* **config** String - Any **additional custom configuration flags** that are not available via the pytesseract function. For example: ``config='--psm 6'``\n\n* **nice** Integer - modifies the processor priority for the Tesseract run. Not supported on Windows. Nice adjusts the niceness of unix-like processes.\n\n* **output_type** Class attribute - specifies the type of the output, defaults to ``string``. For the full list of all supported types, please check the definition of `pytesseract.Output <https://github.com/madmaze/pytesseract/blob/master/pytesseract/pytesseract.py>`_ class.\n\n* **timeout** Integer or Float - duration in seconds for the OCR processing, after which, pytesseract will terminate and raise RuntimeError.\n\n* **pandas_config** Dict - only for the **Output.DATAFRAME** type. Dictionary with custom arguments for `pandas.read_csv <https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.read_csv.html#pandas-read-csv>`_. Allows you to customize the output of **image_to_data**.\n\nCLI usage:\n\n.. code-block:: bash\n\n pytesseract [-l lang] image_file\n\nINSTALLATION\n------------\n\nPrerequisites:\n\n- Python-tesseract requires Python 3.6+\n- You will need the Python Imaging Library (PIL) (or the `Pillow <https://pypi.org/project/Pillow/>`_ fork).\n Please check the `Pillow documentation <https://pillow.readthedocs.io/en/stable/installation.html#basic-installation>`_ to know the basic Pillow installation.\n- Install `Google Tesseract OCR <https://github.com/tesseract-ocr/tesseract>`_\n (additional info how to install the engine on Linux, Mac OSX and Windows).\n You must be able to invoke the tesseract command as *tesseract*. If this\n isn't the case, for example because tesseract isn't in your PATH, you will\n have to change the \"tesseract_cmd\" variable ``pytesseract.pytesseract.tesseract_cmd``.\n Under Debian/Ubuntu you can use the package **tesseract-ocr**.\n For Mac OS users. please install homebrew package **tesseract**.\n\n *Note:* In some rare cases, you might need to additionally install ``tessconfigs`` and ``configs`` from `tesseract-ocr/tessconfigs <https://github.com/tesseract-ocr/tessconfigs>`_ if the OS specific package doesn't include them.\n\n| Installing via pip:\n\nCheck the `pytesseract package page <https://pypi.python.org/pypi/pytesseract>`_ for more information.\n\n.. code-block:: bash\n\n pip install pytesseract\n\n| Or if you have git installed:\n\n.. code-block:: bash\n\n pip install -U git+https://github.com/madmaze/pytesseract.git\n\n| Installing from source:\n\n.. code-block:: bash\n\n git clone https://github.com/madmaze/pytesseract.git\n cd pytesseract && pip install -U .\n\n| Install with conda (via `conda-forge <https://anaconda.org/conda-forge/pytesseract>`_):\n\n.. code-block:: bash\n\n conda install -c conda-forge pytesseract\n\nTESTING\n-------\n\nTo run this project's test suite, install and run ``tox``. Ensure that you have ``tesseract``\ninstalled and in your PATH.\n\n.. code-block:: bash\n\n pip install tox\n tox\n\nLICENSE\n-------\nCheck the LICENSE file included in the Python-tesseract repository/distribution.\nAs of Python-tesseract 0.3.1 the license is Apache License Version 2.0\n\nCONTRIBUTORS\n------------\n- Originally written by `Samuel Hoffstaetter <https://github.com/h>`_\n- `Full list of contributors <https://github.com/madmaze/pytesseract/graphs/contributors>`_\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Python-tesseract is a python wrapper for Google's Tesseract-OCR",
"version": "0.3.13",
"project_urls": {
"Homepage": "https://github.com/madmaze/pytesseract"
},
"split_keywords": [
"python-tesseract",
"ocr",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7a338312d7ce74670c9d39a532b2c246a853861120486be9443eebf048043637",
"md5": "5f7a5e451c773cce28c6834fc79c7699",
"sha256": "7a99c6c2ac598360693d83a416e36e0b33a67638bb9d77fdcac094a3589d4b34"
},
"downloads": -1,
"filename": "pytesseract-0.3.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5f7a5e451c773cce28c6834fc79c7699",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 14705,
"upload_time": "2024-08-16T02:36:10",
"upload_time_iso_8601": "2024-08-16T02:36:10.090408Z",
"url": "https://files.pythonhosted.org/packages/7a/33/8312d7ce74670c9d39a532b2c246a853861120486be9443eebf048043637/pytesseract-0.3.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9fa67d679b83c285974a7cb94d739b461fa7e7a9b17a3abfd7bf6cbc5c2394b0",
"md5": "73f9645e59b437f064d05882b95832ce",
"sha256": "4bf5f880c99406f52a3cfc2633e42d9dc67615e69d8a509d74867d3baddb5db9"
},
"downloads": -1,
"filename": "pytesseract-0.3.13.tar.gz",
"has_sig": false,
"md5_digest": "73f9645e59b437f064d05882b95832ce",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 17689,
"upload_time": "2024-08-16T02:33:56",
"upload_time_iso_8601": "2024-08-16T02:33:56.762649Z",
"url": "https://files.pythonhosted.org/packages/9f/a6/7d679b83c285974a7cb94d739b461fa7e7a9b17a3abfd7bf6cbc5c2394b0/pytesseract-0.3.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-16 02:33:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "madmaze",
"github_project": "pytesseract",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pytesseract"
}
JSON
