Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/baicunko/scanyourpdf
Repository for the Scan Your Pdf community
https://github.com/baicunko/scanyourpdf
Last synced: about 2 months ago
JSON representation
Repository for the Scan Your Pdf community
- Host: GitHub
- URL: https://github.com/baicunko/scanyourpdf
- Owner: baicunko
- License: mit
- Created: 2020-05-09T11:48:05.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-06-30T22:24:40.000Z (about 1 year ago)
- Last Synced: 2024-04-27T14:33:21.767Z (5 months ago)
- Language: Python
- Size: 57.6 KB
- Stars: 590
- Watchers: 5
- Forks: 45
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.TXT
Awesome Lists containing this project
README
# Welcome to ScanYourPDF!
This is my first open-source project so please, feel free to comment on anything that you think requires to be overwritten! The idea behind this software is to allow anyone to make their PDF look like it was scanned. Project is currently running version 1.0 on www.scanyourpdf.com
We were featured in HN for more than 12 hours on the front page! Thanks to everyone that commented and provided feedback on the project. We are currently working on implementing all of them. Feel free to drop of any comments!
[HN Post](https://news.ycombinator.com/item?id=23157408)
# Dependencies
Project requires ImageMagick and GhostScript. This will do the trick on Ubuntu:
```
sudo apt-get install ghostscript
sudo apt-get install imagemagick
```
This should work on macOS with [Homebrew](https://brew.sh/):
```
brew install ghostscript
brew install imagemagick
```
Then the usual virtualenv dance (this within your software directory):
```
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
```
On Ubuntu, PDF support in ImageMagick is disabled by default for security reasons. To "fix" this, change the line in `/etc/ImageMagick-6/policy.xml` from this:
``````
To this:
``````
Be warned that this may be insecure; use at your own risk.
# Gist
The document `scanned_pdf.sh` is a simple Gist with the two commands required to make the PDF look scanned in case you would like to run this program locally. To execute you need to make sure the dependencies have been correctly installed and then run:
```
chmod +x ./scanned_pdf.sh
```
This makes the script executable.
Usage:
```
./scanned_pdf.sh
```
Example:
```
./scanned_pdf.sh scan.pdf
```
# Docker
Run the script from a Docker container
```
docker-compose build
docker-compose run --rm app ./scanned_pdf.sh -o output.pdf input.pdf
```
# Pending
- Contact form for people to send any PDF that may have failed the conversion process to check
- Make a `CONTRIBUTING.md` file for people to help
# Pull request
- I think everything is working for people to start contributing. Any questions or comments please feel free to send me an email at [email protected]