257 lines
12 KiB
Plaintext
257 lines
12 KiB
Plaintext
|
Metadata-Version: 1.2
|
||
|
|
Name: pytesseract
|
||
|
|
Version: 0.3.2
|
||
|
|
Summary: Python-tesseract is a python wrapper for Google's Tesseract-OCR
|
||
|
|
Home-page: https://github.com/madmaze/pytesseract
|
||
|
|
Author: Samuel Hoffstaetter
|
||
|
|
Author-email: samuel@hoffstaetter.com
|
||
|
|
Maintainer: Matthias Lee
|
||
|
|
Maintainer-email: pytesseract@madmaze.net
|
||
|
|
License: Apache License 2.0
|
||
|
|
Description: Python Tesseract
|
||
|
|
================
|
||
|
|
|
||
|
|
.. image:: https://travis-ci.org/madmaze/pytesseract.svg
|
||
|
|
:target: https://travis-ci.org/madmaze/pytesseract
|
||
|
|
:alt: Travis build status
|
||
|
|
|
||
|
|
.. 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
|
||
|
|
|
||
|
|
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
|
||
|
|
|
||
|
|
try:
|
||
|
|
from PIL import Image
|
||
|
|
except ImportError:
|
||
|
|
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')))
|
||
|
|
|
||
|
|
# French text image to string
|
||
|
|
print(pytesseract.image_to_string(Image.open('test-european.jpg'), lang='fra'))
|
||
|
|
|
||
|
|
# 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'))
|
||
|
|
|
||
|
|
# 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')
|
||
|
|
|
||
|
|
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)
|
||
|
|
|
||
|
|
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_tesseract_version** Returns the Tesseract version installed in the system.
|
||
|
|
|
||
|
|
* **image_to_string** Returns the result of a Tesseract OCR run on the image to string
|
||
|
|
|
||
|
|
* **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://github.com/tesseract-ocr/tesseract/wiki/Command-Line-Usage#tsv-output-currently-available-in-305-dev-in-master-branch-on-github>`_
|
||
|
|
|
||
|
|
* **image_to_osd** Returns result containing information about orientation and script detection.
|
||
|
|
|
||
|
|
* **run_and_get_output** Returns the raw output from Tesseract OCR. Gives a bit more control over the parameters that are sent to tesseract.
|
||
|
|
|
||
|
|
**Parameters**
|
||
|
|
|
||
|
|
``image_to_data(image, lang=None, config='', nice=0, output_type=Output.STRING, timeout=0, pandas_config=None)``
|
||
|
|
|
||
|
|
* **image** Object or String - 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/src/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
|
||
|
|
|
||
|
|
$ (env)> pytesseract [-l lang] image_file
|
||
|
|
|
||
|
|
INSTALLATION
|
||
|
|
------------
|
||
|
|
|
||
|
|
Prerequisites:
|
||
|
|
|
||
|
|
- Python-tesseract requires Python 2.7 or Python 3.5+
|
||
|
|
- You will need the Python Imaging Library (PIL) (or the `Pillow <https://pypi.org/project/Pillow/>`_ fork).
|
||
|
|
Under Debian/Ubuntu, this is the package **python-imaging** or **python3-imaging**.
|
||
|
|
- 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:* Make sure that you also have installed ``tessconfigs`` and ``configs`` from `tesseract-ocr/tessconfigs <https://github.com/tesseract-ocr/tessconfigs>`_ or via the OS package manager.
|
||
|
|
|
||
|
|
| Installing via pip:
|
||
|
|
|
||
|
|
Check the `pytesseract package page <https://pypi.python.org/pypi/pytesseract>`_ for more information.
|
||
|
|
|
||
|
|
.. code-block:: bash
|
||
|
|
|
||
|
|
$ (env)> pip install pytesseract
|
||
|
|
|
||
|
|
| Or if you have git installed:
|
||
|
|
|
||
|
|
.. code-block:: bash
|
||
|
|
|
||
|
|
$ (env)> pip install -U git+https://github.com/madmaze/pytesseract.git
|
||
|
|
|
||
|
|
| Installing from source:
|
||
|
|
|
||
|
|
.. code-block:: bash
|
||
|
|
|
||
|
|
$> git clone https://github.com/madmaze/pytesseract.git
|
||
|
|
$ (env)> 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
|
||
|
|
|
||
|
|
$ (env)> pip install tox
|
||
|
|
$ (env)> 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>`_
|
||
|
|
- `Juarez Bochi <https://github.com/jbochi>`_
|
||
|
|
- `Matthias Lee <https://github.com/madmaze>`_
|
||
|
|
- `Lars Kistner <https://github.com/Sr4l>`_
|
||
|
|
- `Ryan Mitchell <https://github.com/REMitchell>`_
|
||
|
|
- `Emilio Cecchini <https://github.com/ceccoemi>`_
|
||
|
|
- `John Hagen <https://github.com/johnthagen>`_
|
||
|
|
- `Darius Morawiec <https://github.com/nok>`_
|
||
|
|
- `Eddie Bedada <https://github.com/adbeda>`_
|
||
|
|
|
||
|
|
Keywords: python-tesseract OCR Python
|
||
|
|
Platform: UNKNOWN
|
||
|
|
Classifier: License :: OSI Approved :: Apache Software License
|
||
|
|
Classifier: Programming Language :: Python
|
||
|
|
Classifier: Programming Language :: Python :: 2
|
||
|
|
Classifier: Programming Language :: Python :: 2.7
|
||
|
|
Classifier: Programming Language :: Python :: 3
|
||
|
|
Classifier: Programming Language :: Python :: 3.5
|
||
|
|
Classifier: Programming Language :: Python :: 3.6
|
||
|
|
Classifier: Programming Language :: Python :: 3.7
|