docscan 1.0.6
This is a document scanner
Requires Python: <4,>=3.5
Keywords: document, scanner, opencv

# Docscan

[![Downloads](https://pepy.tech/badge/docscan)](https://pepy.tech/project/docscan)
[![Downloads](https://pepy.tech/badge/docscan/month)](https://pepy.tech/project/docscan/month)
[![Downloads](https://pepy.tech/badge/docscan/week)](https://pepy.tech/project/docscan/week)
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://img.shields.io/badge/License-MIT-blue.svg)

Docscan is a document scanner. Take a photo of your documents and frame it.

<p style="display: flex;align-items: center;justify-content: center;">
  <img src="https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-1.jpg" width="100" />
  <img src="https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-1.out.png" width="100" />
  <img src="https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-2.png" width="100" />
  <img src="https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-2.out.png" width="100" />
  <img src="https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-3.jpg" width="100" />
  <img src="https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-3.out.png" width="100" />
  <img src="https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-4.jpg" width="100" />
  <img src="https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-4.out.png" width="100" />
  <img src="https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-5.jpg" width="100" />
  <img src="https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-5.out.png" width="100" />
  <img src="https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-6.jpg" width="100" />
  <img src="https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-6.out.png" width="100" />
  <img src="https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-7.jpg" width="100" />
  <img src="https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-7.out.png" width="100" />
  <img src="https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-8.jpg" width="100" />
  <img src="https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-8.out.png" width="100" />
</p>


### Installation

Install it from pypi

```bash
    pip install docscan
```

### Usage as a cli

Scan from a remote image
```bash
    curl -s http://input.png | docscan > output.png
```

Scan from a local file
```bash
    docscan path/to/output.png path/to/input.png
```

### Usage as a library

In `app.py`

```python
import sys
from docscan.doc import scan

sys.stdout.buffer.write(scan(sys.stdin.buffer.read()))

```

Then run
```
    cat input.png | python app.py > out.png
```

### License

Copyright (c) 2020-present [Daniel Gatis](https://github.com/danielgatis)

Licensed under [MIT License](./LICENSE.txt)

### Buy me a coffee
Liked some of my work? Buy me a coffee (or more likely a beer)

<a href="https://www.buymeacoffee.com/danielgatis" target="_blank"><img src="https://bmc-cdn.nyc3.digitaloceanspaces.com/BMC-button-images/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;"></a>