tesseract-ocr

Version, currently master branch1 version
  • master branchlatestJun 6, 2022

github.com/dannnylo/tesseract-ocr-crystal

This is a wrapper of Tesseract OCR. Helping to read characters on an image.

13 stars
0 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  tesseract-ocr:
    github: dannnylo/tesseract-ocr-crystal
    branch: master

master is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal
0.35.0
License
MIT
Author
Danilo Jeremias da Silva <daniloj.dasilva@gmail.com>

Dependencies

This version declares no dependencies.

README

# tesseract-ocr

This package is a wrapper of Tesseract OCR. Helping to read characters on a image.

## Installation

1. Add the dependency to your `shard.yml`:

   ```yaml
   dependencies:
     tesseract-ocr:
       github: dannnylo/tesseract-ocr-crystal
   ```

2. Run `shards install`

## Usage

```crystal
require "tesseract-ocr"
```

Basic usage:

```crystal
Tesseract::Ocr.read("spec/resources/world.png") => "world"
```


With options:

```crystal
Tesseract::Ocr.read("spec/resources/world.png", {  :l => "por", :oem => "1" }) => "world"
```


Convert image to PDF readable.

```crystal
Tesseract::Ocr.to_pdf("spec/resources/world.png", { :oem => "1" }) => "/tmp/RANDOM_NAME.pdf"
```

Reading the image and get words positions

```crystal
Tesseract::OcrWords.read("spec/resources/world.png") => [{word: "world", confidence: 95, x_start: 2, y_start: 2, x_end: 185, y_end: 56}]
```

## Contributing

1. Fork it (<https://github.com/dannnylo/tesseract-ocr-crystal/fork>)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

## Contributors

- [Danilo Jeremias da Silva](https://github.com/dannnylo) - creator and maintainer