Metadata-Version: 2.1
Name: scanbook
Version: 0.1.1
Summary: Tool that processes page images for easier reading
Home-page: https://github.com/bencrowder/scanbook
Author: Ben Crowder
Author-email: ben.crowder@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: click
Requires-Dist: opencv-python
Requires-Dist: scikit-image

# Scanbook

A Python command-line tool for turning page scans into a nice black-and-white PDF.


## Installation

1. Install Imagemagick
2. `pip install scanbook`
3. Make sure the Python binary path is in your $PATH.

### Pipless installation

1. `python setup.py install` instead of `pip install scanbook`

### Dependencies

- `click`
- `opencv-python`
- `scikit-image`
- Imagemagick (`convert`)


## Usage

`scanbook BOOKNAME FILENAMES...`

Example: `scanbook war-and-peace *.jpg`

Options:

- `--threshold NUM` -- set the threshold value, if the images are turning out too light or too dark; must be an odd number (default: 19)
- `--no-cleanup` -- leave the `__BOOKNAME` folder (handy if you want to do anything with the processed image files)
- `--verbose`

Example: `scanbook --verbose --threshold 27 --no-cleanup war-and-peace *.jpg`


