Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/suyesh/ocr_space
Free Online OCR for Ruby - Convert images to text
https://github.com/suyesh/ocr_space
converting-images ocr ocr-ruby ocr-service ocr-space ruby rubygem
Last synced: 7 days ago
JSON representation
Free Online OCR for Ruby - Convert images to text
- Host: GitHub
- URL: https://github.com/suyesh/ocr_space
- Owner: suyesh
- License: mit
- Created: 2016-12-01T18:33:29.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-02-06T21:45:51.000Z (almost 6 years ago)
- Last Synced: 2024-12-19T23:13:32.182Z (14 days ago)
- Topics: converting-images, ocr, ocr-ruby, ocr-service, ocr-space, ruby, rubygem
- Language: Ruby
- Homepage:
- Size: 52.7 KB
- Stars: 70
- Watchers: 3
- Forks: 15
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
![OCR.SPACE](https://ocr.space/Content/Images/ocr.space.logo.png)
[![Gem Version](https://badge.fury.io/rb/[email protected])](https://badge.fury.io/rb/ocr_space)# OcrSpace
Simple API wrapper for [OCR.Space](https://ocr.space), An awesome free API for converting images to text. Register [here](http://space.us11.list-manage1.com/subscribe?u=ce17e59f5b68a2fd3542801fd&id=252aee70a1) for free api key.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'ocr_space'
```And then execute:
$ bundle
Or install it yourself as:
$ gem install ocr_space
Hosted at [rubygems.org](https://rubygems.org/gems/ocr_space)
### ENV Variables (Optional)
Setting env variables with API key is optional but for command line interface to work you will have to set ENV variable 'ocr_api_key' to your API key. For more details on the command line interface, scroll to the bottom of this page.```
$ export ocr_api_key='YOUR API KEY'
```## Usage
![Nicola Tesla](https://bit.ly/2ih9aXt)
## Instantiate OcrSpace resource with API key
```ruby
require 'ocr_space'resource = OcrSpace::Resource.new(apikey: "YOUR API KEY")
#By default it picks up ocr_api_key='YOUR API KEY' from your env variables
```## To convert images from URL
```ruby
result = resource.convert url: "http://bit.ly/2ih9aXt"puts result
=> #[{"TextOverlay"=>{"Lines"=>[], "HasOverlay"=>false, "Message"=>"Text overlay is not provided as it is not requested"}, "FileParseExitCode"=>1, "ParsedText"=>"If you want to find the secrets of the \r\nuniverse, think in terms of energy, \r\nfrequency and vibration. \r\nAZ QUOTES \r\n", "ErrorMessage"=>"", "ErrorDetails"=>""}]result = resource.clean_convert url: "http://bit.ly/2ih9aXt"
puts result
=> #If you want to find the secrets of the universe, think in terms of energy, frequency and vibration. AZ QUOTES
```## To convert images from file upload
```ruby
result = resource.convert file: "/Users/suyesh/Desktop/nicola_tesla.jpg"puts result #Raw result
=> #{"TextOverlay"=>{"Lines"=>[], "HasOverlay"=>false, "Message"=>"Text overlay is not provided as it is not requested"}, "FileParseExitCode"=>1, "ParsedText"=>"If you want to find the secrets of the \r\nuniverse, think in terms of energy, \r\nfrequency and vibration. \r\nAZ QUOTES \r\n", "ErrorMessage"=>"", "ErrorDetails"=>""}
result = resource.clean_convert file: "/Users/suyesh/Desktop/nicola_tesla.jpg"
puts result
=> #If you want to find the secrets of the universe, think in terms of energy, frequency and vibration. AZ QUOTES
```## Command line interface ***BONUS***
You can run ocr_space through shell to get quick result from a image using file path or URL.
```
$ ocr_space /Users/suyesh/Desktop/nicola_tesla.jpg=> If you want to find the secrets of the universe, think in terms of energy, frequency and vibration. AZ QUOTES
```## Optional
You can also pass in Optional attributes
```ruby
isOverlayRequired:
#[Optional] Default = False Allows you to specify if the image/pdf text overlay is required. Overlay could be #used to show the text over the imagelanguage:
#Czech = ce; Danish = dan; Dutch = dut; English = eng; Finnish = fin; French = fre; German = ger;Hungarian=hun;
#Italian = ita; Norwegian = nor; Polish = pol; Portuguese = por; Spanish = spa; Swedish = swe; #ChineseSimplified = chs; Greek = gre; Japanese = jpn; Russian = rus; Turkish = tur; ChineseTraditional = cht; #Korean = kor
```