Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/navchandar/look-like-scanned
Python package to make documents look like they were scanned
https://github.com/navchandar/look-like-scanned
image-to-pdf pdf pdf-scanner pdf-to-scan python scanner
Last synced: 7 days ago
JSON representation
Python package to make documents look like they were scanned
- Host: GitHub
- URL: https://github.com/navchandar/look-like-scanned
- Owner: navchandar
- License: mit
- Created: 2023-05-20T08:38:10.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-17T10:55:58.000Z (17 days ago)
- Last Synced: 2024-12-17T11:38:26.797Z (17 days ago)
- Topics: image-to-pdf, pdf, pdf-scanner, pdf-to-scan, python, scanner
- Language: Python
- Homepage: https://navchandar.github.io/look-like-scanned/
- Size: 9.79 MB
- Stars: 33
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# look-like-scanned
[](https://github.com/navchandar/look-like-scanned/actions/workflows/pylint.yml) [](https://github.com/navchandar/look-like-scanned/actions/workflows/tests.yml)
[](https://github.com/navchandar/look-like-scanned/issues)
[](https://www.python.org/)
- Python script to make documents look like they were scanned.
- Local, Private, Secure, Open-Source and Transparent!
- Converts every page of a given PDF file into an image-based page and applies random askew and brightness (very mild) effects to simulate the appearance of scanned documents.
- The resulting pages are then combined back into an Output PDF file.
- There are options to combine / convert image files into PDF as well.
- Output PDF files are saved in the same folder with a suffix _"File_Name_output.pdf"_
## Installation
Install from the [Python Package Index (PyPI)](https://pypi.org/project/look-like-scanned/)
```shell
pip install look-like-scanned
```
Or to install latest version from GitHub
```shell
git clone https://github.com/navchandar/look-like-scanned.git
cd look-like-scanned
pip install poetry
poetry install
pip install .
```
### Verify Installation:
```shell
# Print help message and usage options available
scanner -h
```
## Usage
This package uses [PIL](https://pypi.org/project/Pillow/) and [pypdfium2](https://pypi.org/project/pypdfium2/) to convert and manipulate image and pdf objects.
This is extended to provide a command-line interface (CLI) for easy usage.
```shell
# Convert all pdf files in folder to scanned pdf
scanner -i .\tests
scanner -i .\tests -f "pdf"
# Convert all pdf files in folder to scanned pdf, set contrast, sharpness and brightness factors
scanner -i .\tests -c 2 -sh 10 -br 2
# Convert all pdf files in folder to scanned without askew
scanner -i .\tests -a no
# Convert specific pdf file in folder to scanned pdf
scanner -i .\tests -f "test.pdf"
# Convert all jpg, jpeg, png, webp files in folder to one pdf file
scanner -i .\tests -f "image"
# Convert all image files in folder in the order of file names
scanner -i .\tests -f "image" -s "name"
# Convert all png files in folder to pdf with 100% quality to one pdf file
scanner -i .\tests -f "png" -q 100
# Convert specific jpg file in folder to pdf with 75% quality to one pdf file
scanner -i .\tests -f "JPG_Test.jpg" -q 75
# Convert all PDF files including sub folders
scanner -i .\tests -f "pdf" -r yes
# Convert all Images including sub folders into one PDF
scanner -i .\tests -f "image" -r yes
# Convert all PDF files including sub folders and save in black & white format
scanner -i .\tests -f "pdf" -r yes -b yes
# Convert all png files including sub folders and make it a little blurry
scanner -i .\tests -f "png" -r yes -b yes -l yes
```
## Arguments
These are the command-line arguments accepted:
- `-i, --input_folder` : Specifies the input folder to read files from and convert. The default value is the current directory.
- Example: `-i /path/to/files` or `-i C:\files\documents`
- `-f, --file_type_or_name` : Specifies the file types to process or the file name to convert. The default value is "pdf" to convert all pdf files in the given input folder.
- Example: `-f pdf` or `-f image.jpg` or `-f image`
- `-q, --file_quality` : Specifies the quality of the converted output files. The value must be between 50 and 100. The default value is 95.
- Example: `-q 90`
- `-a, --askew` : Controls whether to make the output documents slightly askew or slightly tilted. Accepted values are "yes" or "no". The default value is "yes".
- Example: `-a yes` or `--askew no`
- `-b, --black_and_white` : Controls whether to save output documents in black and white format (to make it look like a photocopy) . Accepted values are "yes" or "no". The default value is "no".
- Example: `-b yes` or `--black_and_white no`
- `-l, --blur` : Controls whether to make the output a little bit blurry. Accepted values are "yes" or "no". The default value is "no".
- Example: `-l yes` or `--blur no`
- `-c, --contrast` : Controls contrast factor of the image. A factor of 0.0 gives a solid gray image. A factor of 1.0 gives the original image. Greater values increase the contrast of the image. The default value is 1.
- Example: `-c 2`
- `-sh, --sharpness` : Controls sharpness factor of the image. A factor of 0.0 gives a blurred image. A factor of 1.0 gives the original image. Greater values increase the sharpness of the image. The default value is 1.
- Example: `-sh 2`
- `-br, --brightness` : Controls brightness factor of the image. A factor of 0.0 gives a black image. A factor of 1.0 gives the original image. Greater values increase the brightness of the image. The default value is 1.
- Example: `-br 2`
- `-r, --recurse` : Allows scripts to find all matching files including subdirectories. Accepted values are "yes" or "no". The default value is "yes".
- Example: `-r yes` or `--recurse no`
- `-s, --sort_by` : Allows scripts to sort the files based on name, creation time or modified time. Accepted values are "name", "ctime", "mtime", "none". The default value is "name". If "none" is selected, then the default order of files returned by the OS is used for document conversion.
- Example: `-s name` or `--sort_by none`
❗❗ **Note:** ❗❗
- The supported file types are: ".jpg", ".png", ".jpeg", ".webp", ".pdf".
- The output PDF file size **will be bigger** than the input file because the pages are stored in image format.
- Bookmarks / Links / Metadata will be removed when saving the output file.
- Transparency will be removed from png files when converting to pdf.
- Password protected PDF files are not yet supported.
- [Youtube: How to Insert a Signature on a PDF File](http://www.youtube.com/watch?v=FKlAwFcMutY)
## License
[MIT license](LICENSE)
## Authors
## Support This Project
[](https://paypal.me/navchandar/)
[](https://www.buymeacoffee.com/navchandar/)
[](https://ko-fi.com/navchandar/)