Skip to main content

cli tool wrapper for manipulating multiple pdfs file in parallel using ghostscript (compressing, convert to pdfa, etc.)

Project description

gs-batch-pdf

gs-batch-pdf is a command-line tool for batch (parallel) processing PDF files using Ghostscript, applying the same set of gs options to all files specified while taking care of file renaming.

It offers convenient default settings for compression, PDF/A conversion, and you can also apply any custom Ghostscript options.

Features

  • Batch process multiple PDF files
  • Compress PDFs with various quality settings
  • Convert PDFs to PDF/A format
  • Apply custom Ghostscript options
  • Multi-threaded processing for improved performance
  • Progress tracking with tqdm
  • Automatic file renaming with customizable prefixes and suffixes
  • Option to keep either the smaller file or the new file after processing
  • Cross-platform support (Windows, Linux, macOS)

Installation

To install gs-batch-pdf, make sure you have Python 3.12+ and pipx[^1] installed, then run:

[^1]:pipx will let you install the package in a virtual environment, but the commands will be available from the command line

pipx install gs-batch-pdf

Note: This tool requires Ghostscript to be installed on your system. Make sure you have Ghostscript installed and accessible from the command line.

Usage

Basic usage:

gs_batch and the its alias gsb will be available from the command line.

gs-batch-pdf [OPTIONS] FILES...

Options:

  • --options TEXT: Arbitrary Ghostscript options and switches.
  • --compress TEXT: Compression quality level (e.g., /screen, /ebook, /printer, /prepress) (default: /ebook).
  • --pdfa INTEGER: PDF/A version (1 for PDF/A-1, 2 for PDF/A-2, 3 for PDF/A-3; default: 2).
  • --prefix TEXT: Prefix to add to the output file name.
  • --suffix TEXT: Suffix to add to the output file name before the extension.
  • --keep_smaller / --keep_new: Keep the smaller file between old and new (default: keep smaller).

Examples

  1. Compress multiple PDF files using ebook quality:
gs_batch --compress=/ebook file1.pdf file2.pdf file3.pdf
  1. Convert PDFs to PDF/A-2 format:
gs_batch --pdfa=2 file1.pdf file2.pdf
  1. Compress and Convert PDFs to PDF/A-2 format all pdfs in a folder:
gs_batch --compress --pdfa=2 *.pdf 
  1. Apply custom Ghostscript options:
gs_batch --options="-dPDFSETTINGS=/screen -dColorImageResolution=72" file.pdf
  1. Add prefix^[you can also specify new folder] and suffix to output files:
gs_batch --prefix="./compressed/" --suffix="_v1" --compress=/screen file*.pdf 

Output

After processing, gs-batch-pdf will display a summary table showing the original size, new size, compression ratio, and which file was kept for each processed PDF. The tool will also attempt to open the output folder in your default file manager.

Requirements

  • Python 3.12+
  • Ghostscript
  • click
  • tqdm
  • showinfm

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License.

Acknowledgements

gs-batch-pdf uses Ghostscript for PDF processing. Ghostscript is released under the GNU Affero General Public License (AGPL).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gs_batch_pdf-0.1.1b1.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

gs_batch_pdf-0.1.1b1-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file gs_batch_pdf-0.1.1b1.tar.gz.

File metadata

  • Download URL: gs_batch_pdf-0.1.1b1.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.4 Windows/11

File hashes

Hashes for gs_batch_pdf-0.1.1b1.tar.gz
Algorithm Hash digest
SHA256 b8986d983c5679dbac30ce15f173148e457806e9aec9c8d75bb4f3b6f5ff571c
MD5 6bf81e068b4bd33c90251db21185976a
BLAKE2b-256 09600c8ec53595eb54e294916a0e35404f61b87b0639af2a84a5e82a8980efb9

See more details on using hashes here.

File details

Details for the file gs_batch_pdf-0.1.1b1-py3-none-any.whl.

File metadata

  • Download URL: gs_batch_pdf-0.1.1b1-py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.4 Windows/11

File hashes

Hashes for gs_batch_pdf-0.1.1b1-py3-none-any.whl
Algorithm Hash digest
SHA256 b6af5e0cb56c0486a54a404a3b7af09bf5bbd89a17cf6750ba9bc111adb4b854
MD5 fb82cf356dcb3ec6c205443f187d3d21
BLAKE2b-256 d301ebb1b8aa80716ada2597b4197ce2fe3f4fa054a86a84508459191eb3398f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page