https://github.com/schwarzkopfb/tesseract-ocr

Node.js wrapper for Tesseract OCR CLI.
https://github.com/schwarzkopfb/tesseract-ocr

javascript nodejs ocr tesseract

Last synced: 9 days ago
JSON representation

Node.js wrapper for Tesseract OCR CLI.

• Host: GitHub
• URL: https://github.com/schwarzkopfb/tesseract-ocr
• Owner: schwarzkopfb
• License: mit
• Created: 2017-12-03T13:36:35.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-04-03T16:55:20.000Z (over 2 years ago)
• Last Synced: 2024-10-30T16:20:45.618Z (14 days ago)
• Topics: javascript, nodejs, ocr, tesseract
• Language: JavaScript
• Size: 252 KB
• Stars: 35
• Watchers: 3
• Forks: 12
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![view on npm](http://img.shields.io/npm/v/tesseractocr.svg?style=flat-square)](https://www.npmjs.com/package/tesseractocr)

[![downloads per month](http://img.shields.io/npm/dm/tesseractocr.svg?style=flat-square)](https://www.npmjs.com/package/tesseractocr)

[![node version](https://img.shields.io/badge/node->=8-brightgreen.svg?style=flat-square)](https://nodejs.org/download)

[![build status](https://img.shields.io/travis/schwarzkopfb/tesseract-ocr.svg?style=flat-square)](https://travis-ci.org/schwarzkopfb/tesseract-ocr)

[![test coverage](https://img.shields.io/coveralls/schwarzkopfb/tesseract-ocr.svg?style=flat-square)](https://coveralls.io/github/schwarzkopfb/tesseract-ocr)

[![license](https://img.shields.io/npm/l/tesseractocr.svg?style=flat-square)](https://github.com/schwarzkopfb/tesseractocr/blob/master/LICENSE)

# Tesseract OCR for Node.js

Simple and modern Node.js wrapper implementation for Tesseract OCR CLI.

## Features & Advantages

- focus on high performance

- both promise and callback APIs are supported

- full test coverage

- void of sync operations

- no temp files are used

## Usage

```js

import recognize from 'tesseractocr'

const text = await recognize('/path/to/image.png')

console.log('Yay! Text recognized:', text)

```

**Note:** Despite that it's encouraged to use the more modern promise-based API,

the good old callbacks are still supported.

## API docs

The overall API documentation can be found [here](/docs.md)

## Installation

There is a hard dependency on the [Tesseract project](https://github.com/tesseract-ocr/tesseract).  You can find installation instructions for various platforms on the project site. For Homebrew users, the installation is quick and easy.

    brew install tesseract

You can then go about installing the Node.js package to expose the JavaScript API:

    npm install tesseractocr

## Tests and benchmarks

Clone the repo, `npm install` and then `npm test` or `npm run benchmarks`.

## Changelog

The project's changelog is available [here](/changelog.md)

## License

[MIT](/LICENSE)