# dv

> DocumentVision is a node.js library for processing and understanding scanned documents

Latest version **2.2.0** (published 2019-12-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install dv
pnpm add dv
yarn add dv
bun add dv
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.2.0 |
| Published | 2019-12-04 |
| First published | 2012-09-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/dv) |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 3 |
| Unpacked size | 21.9 MB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 340 |
| Author | creatale GmbH |
| Maintainers | creatale, schulzch |
| Keywords | graphics, vision, image, images, barcode, barcodes, ocr, omr, leptonica, tesseract, zxing |

## Links

- npm: https://www.npmjs.com/package/dv
- Repository: https://github.com/creatale/node-dv
- Issues: https://github.com/creatale/node-dv/issues
- npm.io page: https://npm.io/package/dv

## Dependencies (3)

- [nan](https://npm.io/package/nan.md) ^2.10.0
- [dv.data](https://npm.io/package/dv.data.md) ^1.4.0
- [windows-build-tools](https://npm.io/package/windows-build-tools.md) ^3.1.0

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 2.2.0 (latest) — 2019-12-04
- 2.1.0 — 2018-08-27
- 2.0.1 — 2018-08-10
- 2.0.0 — 2018-08-10
- 1.10.1 — 2015-11-05
- 1.10.0 — 2015-10-21
- 1.9.4 — 2015-10-12
- 1.9.3 — 2015-06-18
- 1.9.2 — 2015-05-07
- 1.9.1 — 2015-04-08
- 1.9.0 — 2015-03-30
- 1.8.1 — 2014-11-27
- 1.8.0 — 2014-07-21
- 1.7.2 — 2014-05-27
- 1.7.1 — 2014-03-29
- … 24 more at https://npm.io/package/dv/versions

## README

# DocumentVision [![NPM version](https://badge.fury.io/js/dv.png)](http://badge.fury.io/js/dv) [![Build Status](https://travis-ci.org/creatale/node-dv.png)](https://travis-ci.org/creatale/node-dv) [![Windows Build status](https://ci.appveyor.com/api/projects/status/4c67hpay2xsrhbrv?svg=true)](https://ci.appveyor.com/project/rashfael/node-dv) [![devDependency Status](https://david-dm.org/creatale/node-dv/dev-status.png)](https://david-dm.org/creatale/node-dv#info=devDependencies)

DocumentVision is a [node.js](http://nodejs.org) library for processing and understanding scanned documents.

## Features

- Image loading using [jpeg-compressor](http://code.google.com/p/jpeg-compressor/), [LodePNG](http://lodev.org/lodepng/) and pixel buffers
- Image manipulation using [Leptonica](http://www.leptonica.com/) (Version 1.69) and [OpenCV](http://opencv.org/) (Version 2.4.9)
- Line Segment Detection using [LSWMS](http://sourceforge.net/projects/lswms/)
- OCR using [Tesseract](http://code.google.com/p/tesseract-ocr/) (Version 3.03)
- OMR for Barcodes using [ZXing](https://github.com/zxing/zxing) (Version 2.3.0)

## Installation

    $ npm install dv

## Quick Start

Once you've installed, download [that image](https://github.com/creatale/node-dv/blob/master/test/fixtures/textpage300.png). You can use any other image containing simple text at 300dpi or higher. Now run the following code snippet to recognize text from your image:

```javascript
var dv = require('dv');
var fs = require('fs');
var image = new dv.Image('png', fs.readFileSync('textpage300.png'));
var tesseract = new dv.Tesseract('eng', image);
console.log(tesseract.findText('plain'));
```

## What's next?

Here are some quick links to help you get started:

- [Introduction](https://github.com/creatale/node-dv/wiki/Introduction)
- [Tutorial](https://github.com/creatale/node-dv/wiki/Tutorial)
- [API Reference](https://github.com/creatale/node-dv/wiki/API)
- [Bug Tracker](https://github.com/creatale/node-dv/issues)
- [Changelog](CHANGELOG.md)

## Versioning

DocumentVision is maintained under the [Semantic Versioning](http://semver.org/) guidelines as much as possible:

- Version number format is `<major>.<minor>.<patch>`
- Breaking backward compatibility bumps the major (resetting minor and patch)
- New additions without breaking backward compatibility bumps the minor (resetting patch)
- Bug fixes and other changes bumps the patch

## License

Licensed under the [MIT License](http://creativecommons.org/licenses/MIT/). See [LICENSE](https://github.com/creatale/node-dv/blob/master/LICENSE).

External libraries are licensed under their respective licenses.

---
_Source: https://npm.io/package/dv · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._