Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cboulanger/abbyy-cloud-ocr
NodeJS Client for the Abbyy Cloud OCR service
https://github.com/cboulanger/abbyy-cloud-ocr
abbyy-cloud-ocr node ocr webservice-client
Last synced: 8 days ago
JSON representation
NodeJS Client for the Abbyy Cloud OCR service
- Host: GitHub
- URL: https://github.com/cboulanger/abbyy-cloud-ocr
- Owner: cboulanger
- Created: 2021-04-30T18:45:52.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-08-12T11:45:50.000Z (over 3 years ago)
- Last Synced: 2024-10-27T14:58:57.904Z (about 2 months ago)
- Topics: abbyy-cloud-ocr, node, ocr, webservice-client
- Language: TypeScript
- Homepage:
- Size: 912 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Abbyy Cloud OCR client
This project provides a NodeJS client with TypeScript support and a command line interface (CLI) for the Abbyy Cloud OCR
service (https://cloud.ocrsdk.com/). It currently implements a subset of the available API methods from the [v1 and v2
web API](https://support.abbyy.com/hc/en-us/sections/360004699840-API-reference):
- processDocument
- listTask/listFinishedTasks
- getApplicationInfo
## Installation
To use the library in your projects, simply `npm install @cboulanger/abbyy-cloud-ocr`. See [the CLI script](run.ts)
for an example on how to use the API.
## Testing
```bash
git clone https://github.com/cboulanger/cboulanger/abbyy-cloud-ocr.git
cd cboulanger/abbyy-cloud-ocr
cp .env.dist ./.env
# edit .env and provide the values needed there
npm install
npm test
```
## Creating an executable
You can create a standalone command line executable file which can be run on the command line by executing `npm run
pkg`. The executables for Linux/Windows/MacOS will be written to the `bin` directory.
> Please note that if you have set environment variables in a `.env` file, the package
> include them and will be visible as plain text in the source! Please remove the file if you intend
> to distribute the built executable. The values will be used as defaults, which is convenient for
> personal use of the executable.
The usage of the executable is
```bash
Usage: abbyy-cloud-ocr- --help
Options:
-u, --service-url The http endpoint of the Cloud OCR Service
-i, --app-id The id of the application
-P, --password The application password
-h, --help display help for command
Commands:
process [options] Process the given files and download the results
list [options] List ongoing or finished tasks.
info
help [command] display help for command
```
```bash
abbyy-cloud-ocr- process [options] file1 [file2 [file3]...]
Process the given files and download the results
Options:
-l, --language Recognition language or comma-separated list of languages, defaults to "English"
-e, --export-format Output format. One of: txt (default), txtUnstructured, rtf, docx, xlsx, pptx, pdfa, pdfSearchable, pdfTextAndImages, xml
-c, --custom-options Other custom options passed to REST-ful call, like 'profile=documentArchiving'
-o, --output-path The path to which to save the processed files
-F, --filenames Output the filenames of the processed and downloaded files
-h, --help display help for command
```
Note that if you don't compile in your `.env` file, you need to set the environment variables defined therein
before calling the executable (or provide them on the command line).