ocr-space-api-alt2

v2.0.1

Fork of Dennnisk's original ocr-space-api with added support for PDF uploading. Provides an easy way to send images to the ocr.space API and get the OCR Result For more information about how to use this package see README

Latest version published 3 years ago

License: MIT

NPM

GitHub

Package Health Score

36 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Limited

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
2.0.1	\|	12/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.0	\|	01/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.0	\|	05/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (4)

GitHub Stars: 1
Forks: 2
Contributors: 1

Direct Usage Popularity

The npm package ocr-space-api-alt2 receives a total of 4 downloads a week. As such, we scored ocr-space-api-alt2 popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package ocr-space-api-alt2, we found that it has been starred 1 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 1
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like ocr-space-api-alt2 is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 0
Open PR: 1
Last Release: 3 years ago
Last Commit: 3 years ago

Further analysis of the maintenance status of ocr-space-api-alt2 based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for ocr-space-api-alt2 is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 5 years
Dependencies: 2 Direct
Versions: 10
Install Size: 426 kB
Dist-tags: 1
# of Files: 11
Maintainers: 1
TS Typings: No

ocr-space-api-alt2 has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

ocr-space-api-alt2

Allow to access ORC.SPACE API to send images and get the embedded text.

More Details: https://ocr.space/ocrapi.

IMPORTANT:

The OCR is provided by OCR.SPACE. I don't have anything with them, I just want to help reworking and sharing this library.

Main changes

The original library was using request, but since it's deprecated, I saw the necessity to migrate from it. Now I'm currently using axios to perform the request.
Since axios doesn't support form data request, I've used query-string.

Installation

First - Register and Get your API key

Get you API key at this link. Just follow their steps.

Second - Install npm package

  npm i ocr-space-api-alt2

  yarn add ocr-space-api-alt2

Usage example

You can see and example at the folder example.

const ocrSpaceApi = require('ocr-space-api-alt2')

const options =  { 
  apikey: '',
  filetype: 'png',
  verbose: true,
  url: `${__dirname}/loveText.jpg`
}

const getText = async () =&gt; {
  try {
    const result = await ocrSpaceApi(options)

    console.log({ result })
  } catch (error) {
    console.error(error)
  }
}

getText()

Options

The available options are an adaptation from the docs.

key	Value	Description
apikey	[Required] - String API key from OCR space API	Get you API key at this link.
url	[Required] - String	Url that points to file you want to get its text from. It can be a url (starting in http), a base64 image or a local file
language	[Optional] - String Arabic=ara Bulgarian=bul Chinese(Simplified)=chs Chinese(Traditional)=cht Croatian = hrv Czech = cze Danish = dan Dutch = dut English = eng Finnish = fin French = fre German = ger Greek = gre Hungarian = hun Korean = kor Italian = ita Japanese = jpn Polish = pol Portuguese = por Russian = rus Slovenian = slv Spanish = spa Swedish = swe Turkish = tur	Language used for OCR. If no language is specified, English `eng` is taken as default. IMPORTANT: The language code has always `3-letters` (not 2). So it is "eng" and not "en". Engine2 has automatic Western language detection, so this value will be ignored.
isOverlayRequired	[Optional] - Boolean	Default = `False` If true, returns the coordinates of the bounding boxes for each word. If false, the OCR'ed text is returned only as a text block (this makes the JSON reponse smaller). Overlay data can be used, for example, to show text over the image.
filetype	[Optional] - String Available values: PDF, GIF, PNG, JPG, TIF, BMP	Overwrites the automatic file type detection based on content-type. Supported image file formats are png, jpg (jpeg), gif, tif (tiff) and bmp. For document ocr, the api supports the Adobe PDF format. Multi-page TIFF files are supported.
detectOrientation	[Optional] - Boolean	If set to true, the api autorotates the image correctly and sets the `TextOrientation` parameter in the JSON response. If the image is not rotated, then TextOrientation=0, otherwise it is the degree of the rotation, e. g. "270".
isCreateSearchablePdf	[Optional] - Boolean	Default = `False` If true, API generates a searchable PDF. This parameter automatically sets isOverlayRequired = true.
isSearchablePdfHideTextLayer	[Optional] - Boolean	Default = `False`. If true, the text layer is hidden (not visible).
scale	[Optional] - Boolean	Default = `False`. If set to true, the api does some internal upscaling. This can improve the OCR result significantly, especially for low-resolution PDF scans. Note that the front page demo uses scale=true, but the API uses scale=false by default. See also this OCR forum post.
isTable	[Optional] - Boolean	If set to true, the OCR logic makes sure that the parsed text result is always returned line by line. This switch is recommended for table OCR, receipt OCR, invoice processing and all other type of input documents that have a table like structure.
OCREngine	[Optional] - Number Available values: 1, 2	Engine 1 is default. See OCR Engines.
verbose	[Optional] - Boolean	Wether or not you want the full response from de OCR API or just the text that was gotten.

Authors

Denis - Initial Work - Initial Documentation - dennnisk.
Anthony Luzquiños - Rework - AnthonyLzq.

Important

This package was not fully tested, and every contribution will be appreciated.

ocr-space-api-alt2 dependencies

@postman/form-data axios

ocr-space-api-alt2 development dependencies

@types/node eslint eslint-config-prettier eslint-config-standard eslint-plugin-import eslint-plugin-node eslint-plugin-prettier standard-version

FAQs

What is ocr-space-api-alt2?

Fork of Dennnisk's original ocr-space-api with added support for PDF uploading. Provides an easy way to send images to ... Visit Snyk Advisor to see a full health score report for ocr-space-api-alt2, including popularity, security, maintenance & community analysis.

Is ocr-space-api-alt2 popular?

The npm package ocr-space-api-alt2 receives a total of 4 weekly downloads. As such, ocr-space-api-alt2 popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is ocr-space-api-alt2 well maintained?

We found indications that ocr-space-api-alt2 is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is ocr-space-api-alt2 safe to use?

While scanning the latest version of ocr-space-api-alt2, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 13 December-2024, at 12:35 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (4)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

ocr-space-api-alt2

Main changes

Installation

First - Register and Get your API key

Second - Install npm package

Usage example

Options

Authors

ocr-space-api-alt2 dependencies

ocr-space-api-alt2 development dependencies

FAQs

What is ocr-space-api-alt2?

Is ocr-space-api-alt2 popular?

Is ocr-space-api-alt2 well maintained?

Is ocr-space-api-alt2 safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues