npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

abbyy-ocr-ts

v0.1.0

Published

NodeJS client and CLI to interact with the ABBYY Cloud OCR service

Downloads

10

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:

  • processDocument
  • listTask/listFinishedTasks
  • getApplicationInfo

Installation

To use the library in your projects, simply npm install @cboulanger/abbyy-cloud-ocr. See the CLI script for an example on how to use the API.

Testing

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

Usage: abbyy-cloud-ocr-<platform> --help

Options:
  -u, --service-url <url>       The http endpoint of the Cloud OCR Service
  -i, --app-id <id>             The id of the application
  -P, --password <password>     The application password
  -h, --help                    display help for command

Commands:
  process [options] <files...>  Process the given files and download the results
  list [options]                List ongoing or finished tasks.
  info
  help [command]                display help for command
abbyy-cloud-ocr-<platform> process [options] file1 [file2 [file3]...] 
Process the given files and download the results

Options:
  -l, --language <language>       Recognition language or comma-separated list of languages, defaults to "English"
  -e, --export-format <format>    Output format. One of: txt (default), txtUnstructured, rtf, docx, xlsx, pptx, pdfa, pdfSearchable, pdfTextAndImages, xml
  -c, --custom-options <options>  Other custom options passed to REST-ful call,  like 'profile=documentArchiving'
  -o, --output-path <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).