formartha / compare-pdf

A tiny Python based package which allows to compare two pdf files

---

PDF Visual Comparison Tool

This utility compares PDF files visually by converting each page into images and then comparing them using OpenCV. It's particularly useful for identifying differences between PDF files that may not be apparent through text comparison alone.

Features

• Compares PDF files visually, page by page.
• Supports multi-page PDF files.
• Reports differences between PDF files, specifying the page number and source file.

Requirements

• Python 3.x
• PyMuPDF (fitz) library
• OpenCV (cv2) library

Installation for local development

1. Clone the repository:

   git clone https://github.com/Formartha/compare-pdf.git

2. Install the required dependencies:

   pip install pymupdf opencv-python

Installation for self usage

pip install compare-pdf

Usage

compare_pdf --pdf <path_to_pdf1> --pdf <path_to_pdf2> ...

• Replace <path_to_pdf1>, <path_to_pdf2>, etc. with the paths to the PDF files you want to compare.
• At least two PDF files are required for comparison.

Example

compare_pdf --pdf file1.pdf --pdf file2.pdf

This will compare full/path/to/file1.pdf and full/path/to/file2.pdf visually, reporting any differences found.

License

This project is licensed under the MIT License - see the LICENSE file for details.

compare-pdf's Issues

fix readme

the readme file doesn't take in account how to install the package. should fix it.

Support grayscale image

Need to support grayscale image as it’s not supported currently.

Create test suite with proper pdf examples

Use pytest framework to create testing for this project.
Add also pipeline for it in GitHub workflow

Create plugin for pytest using it

Create a plugin for pytest that can allow comparing pdf files for testing purposes