Skip to content

pip compatibility #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

pip compatibility #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4a333a5
pip compatibility
not-lain Mar 4, 2025
87e4336
Add wrapper functions for scanning single and multiple documents
not-lain Mar 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,7 @@
*.pyc
.DS_Store
.DS_Store
*.egg-info/
dist/
build/
*.egg
__pycache__/
17 changes: 13 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,25 @@ This project makes use of the transform and imutils modules from pyimagesearch (
![Image Directory of images to be processed](https://github.com/andrewdcampbell/doc_scanner/blob/master/before_after.gif)

#### Here are some examples of images before and after scan:
<img src="https://github.com/andrewdcampbell/doc_scanner/blob/master/sample_images/cell_pic.jpg" height="450"> <img src="https://github.com/andrewdcampbell/doc_scanner/blob/master/output/cell_pic.jpg" height="450">
<img src="https://github.com/andrewdcampbell/doc_scanner/blob/master/sample_images/cell_pic.jpg?raw=true" height="450"> <img src="https://github.com/andrewdcampbell/doc_scanner/blob/master/output/cell_pic.jpg?raw=true" height="450">

<img src="https://github.com/andrewdcampbell/doc_scanner/blob/master/sample_images/receipt.jpg" height="450"> <img src="https://github.com/andrewdcampbell/doc_scanner/blob/master/output/receipt.jpg" height="450">
<img src="https://github.com/andrewdcampbell/doc_scanner/blob/master/sample_images/receipt.jpg?raw=true" height="450"> <img src="https://github.com/andrewdcampbell/doc_scanner/blob/master/output/receipt.jpg?raw=true" height="450">

<img src="https://github.com/andrewdcampbell/doc_scanner/blob/master/sample_images/math_cheat_sheet.JPG" height="450"> <img src="https://github.com/andrewdcampbell/doc_scanner/blob/master/output/math_cheat_sheet.JPG" height="450">
<img src="https://github.com/andrewdcampbell/doc_scanner/blob/master/sample_images/math_cheat_sheet.JPG?raw=true" height="450"> <img src="https://github.com/andrewdcampbell/doc_scanner/blob/master/output/math_cheat_sheet.JPG?raw=true" height="450">

<img src="https://github.com/andrewdcampbell/doc_scanner/blob/master/sample_images/dollar_bill.JPG" width="350"> <img src="https://github.com/andrewdcampbell/doc_scanner/blob/master/output/dollar_bill.JPG" width="350">
<img src="https://github.com/andrewdcampbell/doc_scanner/blob/master/sample_images/dollar_bill.JPG?raw=true" width="350"> <img src="https://github.com/andrewdcampbell/doc_scanner/blob/master/output/dollar_bill.JPG?raw=true" width="350">


### Usage
you can install the repo via the command
```
pip install git+https://github.com/user/repo.git
```
then you can run in your terminal
```
document-scanner (--images <IMG_DIR> | --image <IMG_PATH>) [-i]
```
or you can clone the repo and run the command
```
python scan.py (--images <IMG_DIR> | --image <IMG_PATH>) [-i]
```
Expand Down
0 pyimagesearch/__init__.py → opencv_document_scanner/__init__.py
View file
Open in desktop
File renamed without changes.
0 polygon_interacter.py → ...cv_document_scanner/polygon_interacter.py
View file
Open in desktop
File renamed without changes.
1 change: 1 addition & 0 deletions opencv_document_scanner/pyimagesearch/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import * # noqa: F403
0 pyimagesearch/imutils.py → ...document_scanner/pyimagesearch/imutils.py
View file
Open in desktop
File renamed without changes.
0 pyimagesearch/transform.py → ...cument_scanner/pyimagesearch/transform.py
View file
Open in desktop
File renamed without changes.
Loading