https://github.com/elenaches/python-image-scanner-standalone
An image "scanning" app written in Python using OpenCV, an improvement of my Image scanner, a standalone app that takes an photo of a paper, and outputs an edited image with the paper properly aligned as though it was scanned.
https://github.com/elenaches/python-image-scanner-standalone
executable image-manipulation image-processing opencv opencv-python python standalone
Last synced: about 1 month ago
JSON representation
An image "scanning" app written in Python using OpenCV, an improvement of my Image scanner, a standalone app that takes an photo of a paper, and outputs an edited image with the paper properly aligned as though it was scanned.
- Host: GitHub
- URL: https://github.com/elenaches/python-image-scanner-standalone
- Owner: ElenaChes
- License: mit
- Created: 2024-05-15T18:54:26.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-15T20:25:39.000Z (about 2 years ago)
- Last Synced: 2025-02-01T15:16:02.692Z (over 1 year ago)
- Topics: executable, image-manipulation, image-processing, opencv, opencv-python, python, standalone
- Language: Python
- Homepage:
- Size: 116 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Image scanner - Standalone
An image "scanning" app written in Python using OpenCV.
Description: an improvement of my [Image scanner](https://github.com/ElenaChes/Python-Image-scanner), a standalone app that takes an photo of a paper, and outputs an edited image with the paper properly aligned as though it was scanned.
Content
- [Dependencies](#dependencies)
- [Installation](#installation)
- [Using the executable](#using-the-executable)
- [Running the raw code](#running-the-raw-code)
- [Creating an executable from the code](#creating-an-executable-from-the-code)
- [Usage](#usage)
image.jpg ⇨ image_scanned.png
# Dependencies
1. Python 3.7.0
The app could work with different versions, but this is the one that was tested.
# Installation
## Using the executable
1. Download `Image Scanner.zip` and extract its contents into a folder.
> [!TIP]
> Create a shortcut for `Image Scanner/Image Scanner.exe` outside the folder to easily access the app.
## Running the raw code
1. Create a new directory, for example `scanner`, and place `imageScanner.py` and `scanner.ico` inside of it.
2. Open the directory in your Terminal:
```
cd scanner
```
3. Create a virtual environment:
```
python -m venv opencv-env
```
4. Activate the environment :
```
.\opencv-env\Scripts\activate
```
5. Install needed packages:
```
pip install opencv-contrib-python matplotlib
```
## Creating an executable from the code
To create `Image Scanner/Image Scanner.exe` the following command was used:
```
pyinstaller --onedir --icon=scanner.ico --add-data="scanner.ico;." --windowed --name="Image Scanner" imageScanner.py
```
> While `scanner.ico` is the icon used for the app.
If you don't want to use an icon you can remove the following line from `imageScanner.py`:
```
root.iconbitmap("scanner.ico")
```
And create an executable using:
```
pyinstaller --onedir --windowed --name="Image Scanner" imageScanner.py
```
# Usage
1. Run `Image Scanner/Image Scanner.exe` (or `imageScanner.py`).
2. Choose an image to edit.
3. Choose a location to export the new image to and name it.
> [!NOTE]
> Common causes for failing to process the image:
> - The paper isn't visible in its entirety in the input image.
> - The paper and the background color aren't distinct enough in the input image.