docscan


Namedocscan JSON
Version 1.0.5 PyPI version JSON
download
home_pagehttps://github.com/danielgatis/docscan
SummaryThis is a document scanner
upload_time2023-01-11 14:13:33
maintainer
docs_urlNone
authorDaniel Gatis
requires_python>=3.5, <4
license
keywords document scanner opencv
VCS
bugtrack_url
requirements click flask imutils numpy opencv-python rembg waitress
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # 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>

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/danielgatis/docscan",
    "name": "docscan",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.5, <4",
    "maintainer_email": "",
    "keywords": "document,scanner,opencv",
    "author": "Daniel Gatis",
    "author_email": "danielgatis@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/34/e2/f4f450c8bb4b9c1b59683e8ebc8d1557f7e273a78939c4c2350c097b727e/docscan-1.0.5.tar.gz",
    "platform": null,
    "description": "# Docscan\n\n[![Downloads](https://pepy.tech/badge/docscan)](https://pepy.tech/project/docscan)\n[![Downloads](https://pepy.tech/badge/docscan/month)](https://pepy.tech/project/docscan/month)\n[![Downloads](https://pepy.tech/badge/docscan/week)](https://pepy.tech/project/docscan/week)\n[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://img.shields.io/badge/License-MIT-blue.svg)\n\nDocscan is a document scanner. Take a photo of your documents and frame it.\n\n<p style=\"display: flex;align-items: center;justify-content: center;\">\n  <img src=\"https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-1.jpg\" width=\"100\" />\n  <img src=\"https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-1.out.png\" width=\"100\" />\n  <img src=\"https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-2.png\" width=\"100\" />\n  <img src=\"https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-2.out.png\" width=\"100\" />\n  <img src=\"https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-3.jpg\" width=\"100\" />\n  <img src=\"https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-3.out.png\" width=\"100\" />\n  <img src=\"https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-4.jpg\" width=\"100\" />\n  <img src=\"https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-4.out.png\" width=\"100\" />\n  <img src=\"https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-5.jpg\" width=\"100\" />\n  <img src=\"https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-5.out.png\" width=\"100\" />\n  <img src=\"https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-6.jpg\" width=\"100\" />\n  <img src=\"https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-6.out.png\" width=\"100\" />\n  <img src=\"https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-7.jpg\" width=\"100\" />\n  <img src=\"https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-7.out.png\" width=\"100\" />\n  <img src=\"https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-8.jpg\" width=\"100\" />\n  <img src=\"https://raw.githubusercontent.com/danielgatis/docscan/master/examples/doc-8.out.png\" width=\"100\" />\n</p>\n\n\n### Installation\n\nInstall it from pypi\n\n```bash\n    pip install docscan\n```\n\n### Usage as a cli\n\nScan from a remote image\n```bash\n    curl -s http://input.png | docscan > output.png\n```\n\nScan from a local file\n```bash\n    docscan path/to/output.png path/to/input.png\n```\n\n### Usage as a library\n\nIn `app.py`\n\n```python\nimport sys\nfrom docscan.doc import scan\n\nsys.stdout.buffer.write(scan(sys.stdin.buffer.read()))\n\n```\n\nThen run\n```\n    cat input.png | python app.py > out.png\n```\n\n### License\n\nCopyright (c) 2020-present [Daniel Gatis](https://github.com/danielgatis)\n\nLicensed under [MIT License](./LICENSE.txt)\n\n### Buy me a coffee\nLiked some of my work? Buy me a coffee (or more likely a beer)\n\n<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>\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "This is a document scanner",
    "version": "1.0.5",
    "split_keywords": [
        "document",
        "scanner",
        "opencv"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "91e8fd40379d091d9004b308c2185eb1b3b45ad63446ec13bab09b417ebf0cdb",
                "md5": "02cb7b294c9dd8bacd9fd85340fa856c",
                "sha256": "d505a66ea893d94743134eba35a9fbe545aaa4b3bcb356d8c7ec5f081c8c1dd5"
            },
            "downloads": -1,
            "filename": "docscan-1.0.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "02cb7b294c9dd8bacd9fd85340fa856c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.5, <4",
            "size": 5285,
            "upload_time": "2023-01-11T14:13:31",
            "upload_time_iso_8601": "2023-01-11T14:13:31.628478Z",
            "url": "https://files.pythonhosted.org/packages/91/e8/fd40379d091d9004b308c2185eb1b3b45ad63446ec13bab09b417ebf0cdb/docscan-1.0.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "34e2f4f450c8bb4b9c1b59683e8ebc8d1557f7e273a78939c4c2350c097b727e",
                "md5": "048d8a76847d183878fc74dc552f4ba6",
                "sha256": "b1ff3ad6ed328c086320afed0f7ddede5bdc61941eb74ae817e7cd9f9e71fcf2"
            },
            "downloads": -1,
            "filename": "docscan-1.0.5.tar.gz",
            "has_sig": false,
            "md5_digest": "048d8a76847d183878fc74dc552f4ba6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.5, <4",
            "size": 5028,
            "upload_time": "2023-01-11T14:13:33",
            "upload_time_iso_8601": "2023-01-11T14:13:33.040572Z",
            "url": "https://files.pythonhosted.org/packages/34/e2/f4f450c8bb4b9c1b59683e8ebc8d1557f7e273a78939c4c2350c097b727e/docscan-1.0.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-11 14:13:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "danielgatis",
    "github_project": "docscan",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "click",
            "specs": []
        },
        {
            "name": "flask",
            "specs": []
        },
        {
            "name": "imutils",
            "specs": []
        },
        {
            "name": "numpy",
            "specs": []
        },
        {
            "name": "opencv-python",
            "specs": []
        },
        {
            "name": "rembg",
            "specs": []
        },
        {
            "name": "waitress",
            "specs": []
        }
    ],
    "lcname": "docscan"
}
Daniel Gatis
Elapsed time: 0.03039s