negassab / ocrspace

A Python API wrapper for the ocr.space Optical Character Recognition API.

ocrspace

A Python wrapper for using the ocr.space API.

Installation

Simply install from pip:

pip install ocrspace

Use

First, get an API key from Free OCR API, otherwise the default apikey helloworld will be used, which is severely rate limited.

First you'll need to import and instantiate the API wrapper:

import ocrspace

api_key = 'apikey retrieved from Free OCR API'

api = ocrspace.API(api_key=api_key)
# Or if you have a custom API host, API key or desired language, pass those:
api = ocrspace.API(endpoint='https://example.host', api_key=api_key, language=ocrspace.Language.Croatian)

If you wish to change the OCR engine used, use the enum class Engine from ocrspace and pass the value of ocrspace.Engine.ENGINE_2 to the api instantiation. By default it uses ocrspace.Engine.ENGINE_1:

import ocrspace

api_key = "apikey retrieved from Free OCR API"

api = ocrspace.API(api_key=api_key, engine=ocrspace.Engine.ENGINE_2)
# Or if you have a custom API host, API key or desired language, pass those:
api = ocrspace.API(endpoint='https://example.host', api_key=api_key, language=ocrspace.Language.Croatian, engine=ocrspace.Engine.ENGINE_2)

To perform recognition on an image hosted at some URL:

api.ocr_url('URL of image goes here')

Or, if you have an image locally upon which to perform recognition:

api.ocr_file('image.jpg')
# or:
api.ocr_file(open('image.jpg', 'rb'))  # or any other file pointer

That's it! Look at example.py for a demonstration.

Authorship

This package was created by Ali Najafi and is maintained by Erik Boesen and Negassa Berhanu.

License

MIT