Shard Detail

image_to_html v0.1.0

OCR an image and output HTML containing the image and its extracted text

Install & Use

Add the following code to your project's shard.yml under:

dependencies to use in production
- OR -
development_dependencies to use in development


image_to_html:
  github: garethrees/image_to_html

Readme

ImageToHTML

CLI tool to OCR an image and output HTML containing the image and its extracted text.

$ image-to-html hello.jpg > ~/tmp/hello.jpg.html

Output of ImageToHTML

Installation

This program must be compiled from source.

Prerequisites:

  • A working Crystal compiler is needed.
  • The tesseract binary must be available in your PATH.
  1. Clone this git repo:
$ git clone git@github.com:garethrees/image_to_html.git
  1. To build a binary:
$ make bin/image-to-html
  1. To use as a library, add the dependency to your shard.yml:
dependencies:
  image_to_html:
    github: garethrees/image_to_html
  1. Run shards install

Usage

As a binary:

# Print the HTML to stdout
$ bin/image-to-html /path/to/image.jpg

# You can redirect stdout to create a HTML file
$ bin/image-to-html /path/to/image.jpg > image.jpg.html

As a library:

# Just generate the HTML
html = ImageToHtml.run("/path/to/image.jpg")

# Or build it up yourself
html = ImageToHtml::Html.new(
  ImageToHtml::Image.new(
    Path["/path/to/image.jpg"]
  )
).to_s

Contributing

  1. Fork it (https://github.com/garethrees/image_to_html/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Make sure the tests pass (make test)
  4. Commit your changes (git commit -am 'Add some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create a new Pull Request

Contributors

Credits