https://github.com/hkdb/cpdf
A script to simplify compressing PDF file size with GhostScript
https://github.com/hkdb/cpdf
Last synced: 5 months ago
JSON representation
A script to simplify compressing PDF file size with GhostScript
- Host: GitHub
- URL: https://github.com/hkdb/cpdf
- Owner: hkdb
- License: mit
- Created: 2018-05-10T16:46:53.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-24T11:51:14.000Z (almost 2 years ago)
- Last Synced: 2024-06-24T13:14:06.193Z (almost 2 years ago)
- Language: Python
- Size: 25.4 KB
- Stars: 75
- Watchers: 3
- Forks: 23
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# cPDF
**maintained by:** hkdb \<\>
## Description
A Python script that simplifies compressing pdf files with gs.
## Usage Example
Check file size of test.pdf:
```
hkdb@machine:~/test$ ll
total 31M
drwxrwxr-x 2 hkdb hkdb 4.0K May 1 14:59 .
drwxr-xr-x 94 hkdb hkdb 4.0K Apr 30 21:45 ..
-rw-rw-r-- 1 hkdb hkdb 31M Apr 29 23:32 test.pdf
```
Help:
```
hkdb@machine:~/test$ cpdf help
This is a script to compress a pdf file with the convention of: cpdf [type: screen, ebook, printer, prepress, or default] [input file name] [output file name] . To learn more about the different types, use the "types" flag (ie. cpdf types)
```
List the preset types of compression settings:
```
hkdb@machine:~/test$ cpdf types
screen - selects low-resolution output similar to the Acrobat Distiller "Screen Optimized" setting.
ebook - selects medium-resolution output similar to the Acrobat Distiller "eBook" setting.
printer - selects output similar to the Acrobat Distiller "Print Optimized" setting.
prepress - selects output similar to Acrobat Distiller "Prepress Optimized" setting.
default - selects output intended to be useful across a wide variety of uses, possibly at the expense of a larger output file.
```
Compress:
```
hkdb@machine:~/test$ cpdf ebook test.pdf compressed.pdf
hkdb@machine:~/test$ ll
total 35M
drwxrwxr-x 2 hkdb hkdb 4.0K May 1 15:00 .
drwxr-xr-x 94 hkdb hkdb 4.0K Apr 30 21:45 ..
-rw-rw-r-- 1 hkdb hkdb 4.0M May 1 15:02 compressed.pdf
-rw-rw-r-- 1 hkdb hkdb 31M Apr 29 23:32 test.pdf
hkdb@machine:~/test$
```
Notice that compressed.pdf is 4M; the results from compressing a 31M pdf? I then opened up compressed.pdf and it still looked great!
You can also specify input and output files with full path:
```
hkdb@machine:~/test$ cpdf ebook /home/hkdb/test.pdf /home/hkdb/Downloads/test-compressed.pdf
```
Version Checker:
```
hkdb@machine:~/test$ cpdf version
cPDF v2.0
hkdb@machine:~/test$
```
As of v1.1, color coding certain output text has been added to improve readability:
## Under the Hood
It essentially takes your arguments and turns it into the following Ghostscript command:
```
gs -sDEVICE=pdfwrite -dCompatibilityLevel=1.6 -dPDFSETTINGS=/ebook
-dNOPAUSE -dQUIET -dBATCH -sOutputFile=[compressed.pdf]
"[input.pdf]"
```
## Error Handling
Currently, if any of the below conditions are met, the script will print an error/warning message and exit. This is designed to prevent any dangerous execution of Ghostscript and to remind users in case they forget to input the command with the right convention. For the ones that are questionable, it will warn the user and provide a chance to cancel or confirm.
Convention:
- Less than 3 arguments given
- Invalid compression type argument
Ghostscript:
- Input File Does Not End with .pdf
- Input File and Output File are the same
- Input File Name Contains Unsupported Characters(| ; ` > < } { # *)
- Output File Name Contains Unsupported Characters(| ; ` > < } { # *)
Questionable Conditions that the application will verify with User via A Dialog Message:
- Output File does not End with .pdf, Verify with User That's Really What They Want
- Output File Name Matches a File in the Output Directory
## Installation
Linux / Mac / FreeBSD:
```bash
curl -sL https://github.com/hkdb/cpdf/releases/latest/download/install.sh | bash
```
You will still have to manually ensure `~/.local/bin` is in $PATH
Windows:
```powershell
Invoke-WebRequest -Uri "https://github.com/hkdb/cpdf/releases/latest/download/install.bat" -OutFile "install.bat"; .\install.bat
```
## Changelog
See [CHANGELOG.md](CHANGELOG.md)
## Disclaimer
This application is maintained by volunteers and in no way do the maintainers make any guarantees. Please use at your own risk!
## Recognition
Many thanks to Dr. Haggen So for sharing the following link that inspired me to write this script:
https://www.tjansson.dk/2012/04/compressing-pdfs-using-ghostscript-under-linux/
This is an Open Source utility sponsored by 3DF Limited's Open Source Initiative:
https://osi.3df.io
https://www.3df.com.hk
## Want a graphical alternative instead?
Check out [Densify](https://github.com/hkdb/densify), a GTK+ GUI Application written in Python that simplifies compressing PDF files with Ghostscript