Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »

scandigilib

1.0.5 • Public • Published

scandigilib Build Status

Coverage Status

A library that generates thumbnails and metadata database for a digital library

Install

Install with npm

$ npm i scandigilib

Depends on the pdf-image library so ensure you have convert, gs, and pdfinfo (part of poppler) commands. see pdf-image for installation instructions.

Usage

Scanning a whole directory.

This recursively scans the directory generating a thumbnail and metadata for each file, storing the thumbnails and a database.json(for the metadata) file in the destination directory.

var scandigilib = require('scandigilib');
 
scandigilib.scanPDFdir([path-to-src-dir], [path-to-dest-dir]);
 

Scanning a single file.

This generates a thumbnail which is stored at the destination directory and adds a single entry into the database.json file in the destination directory.

var scandigilib = require('scandigilib');
 
scandigilib.scanPDF([path-to-src-file], [path-to-dest-dir]);
 

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

kwadwo amankwa

License

Copyright © 2018 kwadwo amankwa Licensed under the ISC license.


This file was generated by readme-generator on November 16, 2018.

install

npm i scandigilib

Downloadsweekly downloads

3

version

1.0.5

license

ISC

last publish

collaborators

  • avatar
Report a vulnerability