https://github.com/kaelzhang/penteract-ocr
⭐️ The native node.js bindings to the Tesseract OCR project.
https://github.com/kaelzhang/penteract-ocr
n-api nodejs ocr ocr-engine optical-character-recognition penteract tesseract
Last synced: about 1 year ago
JSON representation
⭐️ The native node.js bindings to the Tesseract OCR project.
- Host: GitHub
- URL: https://github.com/kaelzhang/penteract-ocr
- Owner: kaelzhang
- License: other
- Created: 2017-08-23T02:28:02.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-09-10T09:40:00.000Z (over 7 years ago)
- Last Synced: 2025-04-09T03:16:13.093Z (about 1 year ago)
- Topics: n-api, nodejs, ocr, ocr-engine, optical-character-recognition, penteract, tesseract
- Language: C++
- Homepage:
- Size: 1.01 MB
- Stars: 124
- Watchers: 3
- Forks: 13
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
[](https://travis-ci.org/kaelzhang/node-penteract)
[](https://codecov.io/gh/kaelzhang/node-penteract)
# penteract
The native Node.js bindings to the [Tesseract OCR](https://github.com/tesseract-ocr/tesseract) project.
- Using Node.js bindings, avoid spawning `tesseract` command line.
- Asynchronous I/O: Image reading and processing in insulated event loop backed by [libuv](https://github.com/libuv/libuv).
- Support to read image data from JavaScript `buffer`s.
Contributions are welcome.
## Install
First of all, a g++ 4.9 compiler is required.
Before install `penteract`, the following dependencies should be installed
```sh
$ brew install pkg-config tesseract # mac os
```
Then npm install
```sh
$ npm install penteract
```
### To Use with Electron
Due to the limitation of node native modules, if you want to use `penteract` with electron, add a `.npmrc` file to the root of your electron project, before `npm install`:
```ini
runtime = electron
; The version of the local electron,
; use `npm ls electron` to figure it out
target = 1.7.5
target_arch = x64
disturl = https://atom.io/download/atom-shell
```
## Usage
### Recognize an Image Buffer
```js
import {
recognize
} from 'penteract'
import fs from 'fs-extra'
const filepath = path.join(__dirname, 'test', 'fixtures', 'penteract.jpg')
fs.readFile(filepath).then(recognize).then(console.log) // 'penteract'
```
### Recognize a Local Image File
```js
import {
fromFile
} from 'penteract'
fromFile(filepath, {lang: 'eng'}).then(console.log) // 'penteract'
```
## recognize(image [, options])
- **image** `Buffer` the content buffer of the image file.
- **options** `PenteractOptions=` optional
Returns `Promise.` the recognized text if succeeded.
## fromFile(filepath [, options])
- **filepath** `Path` the file path of the image file.
- **options** `PenteractOptions=`
Returns `Promise.`
### `PenteractOptions` `Object`
```js
{
// @type `(String|Array.)=eng`,
//
// Specifies language(s) used for OCR.
// Run `tesseract --list-langs` in command line for all supported languages.
// Defaults to `'eng'`.
//
// To specify multiple languages, use an array.
// English and Simplified Chinese, for example:
// ```
// lang: ['eng', 'chi_sim']
// ```
lang: 'eng'
}
```
## `Promise.reject(error)`
- **error** `Error` The JavaScript `Error` instance
- **code** `String` Error code.
- **message** `String` Error message.
- other properties of `Error`.
### code: `ERR_READ_IMAGE`
Rejects if it fails to read image data from file or buffer.
### code: `ERR_INIT_TESSER`
Rejects if tesseract fails to initialize
## Example of Using with Electron
```js
// For details of `mainWindow: BrowserWindow`, see
// https://github.com/electron/electron/blob/master/docs/api/browser-window.md
mainWindow.capturePage({
x: 10,
y: 10,
width: 100,
height: 10
}, (data) => {
recognize(data.toPNG()).then(console.log)
})
```
## Compiling Troubles
For Mac OS users, if you are experiencing trouble when compiling, run the following command:
```sh
$ xcode-select --install
```
will resolve most problems.
Warnings:
```
xcode-select: error: tool 'xcodebuild' requires Xcode, but active developer directory '/Library/Developer/CommandLineTools' is a command line tools instance
```
resolver:
```sh
$ sudo xcode-select -s /Applications/Xcode.app/Contents/Developer
```
## License
MIT