diffpdf 0.3.2__tar.gz → 1.1.0__tar.gz

{diffpdf-0.3.2 → diffpdf-1.1.0}/.github/dependabot.yml

@@ -1,6 +1,6 @@
 version: 2
 updates:
-  - package-ecosystem: "pip"
+  - package-ecosystem: "uv"
     directory: "/"
     schedule:
       interval: "weekly"

diffpdf-1.1.0/.github/workflows/build.yml

@@ -0,0 +1,62 @@
+name: Build
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        # Tests compatibility across Ubuntu/Windows and Python/package version extremes
+        os: [ubuntu-latest, windows-latest]
+        dependencies: [locked, oldest]
+
+    steps:
+      - uses: actions/checkout@v6
+
+      # When searching for a system Python version, uv will use the first compatible version - not the newest version.
+      # Therefore, make sure the newest version is available on the runner.
+      - name: Install Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: 3.x
+          
+      # At the time of writing there is no way to force uv select the lowest version of Python.
+      # Therefore, extract this from pyproject.toml
+      # More info: https://github.com/astral-sh/uv/issues/16333
+      - name: Extract minimum Python version from pyproject.toml
+        if: matrix.dependencies == 'oldest'
+        id: python-version
+        shell: bash
+        run: |
+          MIN_PY=$(grep 'requires-python' pyproject.toml | sed -E 's/[^0-9.]//g')
+          echo "min=$MIN_PY" >> $GITHUB_OUTPUT
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: "latest"
+
+      - name: Install locked dependencies
+        if: matrix.dependencies == 'locked'
+        run: uv sync --locked
+
+      - name: Install oldest dependencies
+        if: matrix.dependencies == 'oldest'
+        run: uv sync --resolution lowest --python ${{ steps.python-version.outputs.min }}
+
+      - name: Run pre-commit hooks
+        if: matrix.dependencies == 'locked'
+        run: uv run pre-commit run --all-files
+
+      - name: Run pytest
+        run: uv run pytest
+        
+      - name: Upload coverage reports to Codecov
+        if: matrix.os == 'ubuntu-latest' && matrix.dependencies == 'locked'
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

{diffpdf-0.3.2 → diffpdf-1.1.0}/.github/workflows/pypi-publish.yml

@@ -29,4 +29,4 @@ jobs:
     - name: Publish package to PyPI
       uses: pypa/gh-action-pypi-publish@release/v1
       with:
-        verbose: true
+        verbose: true

diffpdf-1.1.0/.pre-commit-config.yaml

@@ -0,0 +1,36 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-illegal-windows-names
+      - id: check-merge-conflict
+      - id: detect-private-key
+      - id: end-of-file-fixer
+
+  - repo: local
+    hooks:
+      - id: uv-sync-check
+        name: check uv is synced
+        entry: uv lock --check -q
+        language: system
+        pass_filenames: false
+
+      - id: ruff-lint
+        name: lint
+        entry: uv run ruff check --fix -q
+        language: system
+        pass_filenames: false
+
+      - id: ruff-format
+        name: format
+        entry: uv run ruff format -q
+        language: system
+        pass_filenames: false
+
+      - id: ty
+        name: type check
+        entry: uv run ty check -q
+        language: system
+        pass_filenames: false

{diffpdf-0.3.2 → diffpdf-1.1.0}/.vscode/extensions.json

@@ -5,7 +5,6 @@
 	// List of extensions which should be recommended for users of this workspace.
 	"recommendations": [
 		"ms-python.python",
-		"matangover.mypy",
 		"charliermarsh.ruff",
 		"ryanluker.vscode-coverage-gutters",
 		"astral-sh.ty"
@@ -14,4 +13,4 @@
 	"unwantedRecommendations": [
 		"ms-python.vscode-pylance"
 	]
-}
+}

{diffpdf-0.3.2 → diffpdf-1.1.0}/.vscode/settings.json

@@ -6,13 +6,7 @@
         "source.organizeImports.ruff": "explicit"
     },
 
-    // Enable MyPy type checker
-    "mypy.runUsingActiveInterpreter": true,
-
     // Configure Pytest
-    "python.testing.pytestArgs": [
-        "tests"
-    ],
     "python.testing.unittestEnabled": false,
-    "python.testing.pytestEnabled": true
-}
+    "python.testing.pytestEnabled": true,
+}

{diffpdf-0.3.2 → diffpdf-1.1.0}/MANIFEST.in

@@ -1,2 +1,2 @@
 include README.md
-include LICENSE
+include LICENSE

{diffpdf-0.3.2 → diffpdf-1.1.0}/PKG-INFO

@@ -1,27 +1,23 @@
 Metadata-Version: 2.4
 Name: diffpdf
-Version: 0.3.2
+Version: 1.1.0
 Summary: A tool for comparing PDF files
 Project-URL: Homepage, https://github.com/JustusRijke/DiffPDF
 Project-URL: Issues, https://github.com/JustusRijke/DiffPDF/issues
 Author-email: Justus Rijke <justusrijke@gmail.com>
 License-Expression: MIT
 License-File: LICENSE
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python :: 3
 Classifier: Typing :: Typed
-Requires-Python: >=3.10
-Requires-Dist: click
+Requires-Python: >=3.10.0
+Requires-Dist: click>=8
 Requires-Dist: pillow>=10.0.0
-Requires-Dist: pixelmatch-fast>=1.3.0
+Requires-Dist: pixelmatch-fast>=1.3.1
+Requires-Dist: pre-commit>=4.5.1
 Requires-Dist: pymupdf>=1.23.0
-Provides-Extra: dev
-Requires-Dist: mypy; extra == 'dev'
-Requires-Dist: pytest; extra == 'dev'
-Requires-Dist: pytest-cov; extra == 'dev'
-Requires-Dist: ruff; extra == 'dev'
 Description-Content-Type: text/markdown
 
 # DiffPDF
@@ -30,6 +26,7 @@ Description-Content-Type: text/markdown
 [![codecov](https://codecov.io/gh/JustusRijke/DiffPDF/graph/badge.svg?token=O3ZJFG6X7A)](https://codecov.io/gh/JustusRijke/DiffPDF)
 [![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue)](https://www.python.org/downloads/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![PyPI - Version](https://img.shields.io/pypi/v/DiffPDF)](https://pypi.org/project/DiffPDF/)
 [![PyPI - Downloads](https://img.shields.io/pypi/dw/DiffPDF)](https://pypi.org/project/DiffPDF/)
 
 CLI tool for detecting structural, textual, and visual differences between PDF files, for use in automatic regression tests.
@@ -47,12 +44,15 @@ Each stage only runs if all previous stages pass.
 
 ## Installation
 
+Install Python (v3.10 or higher) and install the package:
+
 ```bash
 pip install diffpdf
 ```
 
 ## CLI Usage
-```
+
+```bash
 Usage: diffpdf [OPTIONS] REFERENCE ACTUAL
 
   Compare two PDF files for structural, textual, and visual differences.
@@ -60,13 +60,13 @@ Usage: diffpdf [OPTIONS] REFERENCE ACTUAL
 Options:
   --threshold FLOAT       Pixelmatch threshold (0.0-1.0)
   --dpi INTEGER           Render resolution
-  --output-dir DIRECTORY  Diff image output directory (optional, if not specified no diff images are saved)
+  --output-dir DIRECTORY  Diff output directory (saves text diffs and visual diff images on failure)
   -v, --verbose           Increase verbosity
   --version               Show the version and exit.
   --help                  Show this message and exit.
 ```
 
-**Exit Codes**
+### Exit Codes
 
 - `0` — Pass (PDFs are equivalent)
 - `1` — Fail (differences detected)
@@ -77,19 +77,44 @@ Options:
 ```python
 from diffpdf import diffpdf
 
-# Basic usage (no diff images saved)
+# Basic usage (no diff output saved)
 diffpdf("reference.pdf", "actual.pdf")
 
-# With options (save diff images to ./output directory)
-diffpdf("reference.pdf", "actual.pdf", output_dir="./output", threshold=0.2, dpi=150, verbose=True)
+# With options (save text diffs and visual diff images to ./output directory)
+diffpdf("reference.pdf", "actual.pdf", output_dir="./output", dpi=300)
 ```
 
 ## Development
 
+Install [uv](https://github.com/astral-sh/uv?tab=readme-ov-file#installation). Then, install dependencies & activate the automatically generated virtual environment:
+
+```bash
+uv sync --locked
+source .venv/bin/activate
+```
+
+Skip `--locked` to use the newest dependencies (this might modify `uv.lock`)
+
+### Testing
+
+Run tests:
+
+```bash
+pytest
+```
+
+### Quality Assurance (QA)
+
+Automatically run code quality checks before every commit using [pre-commit](https://pre-commit.com/):
+
+```bash
+pre-commit install
+```
+
+This installs git hooks that run ruff, type checks, and other checks before each commit. You can run manually at any time with:
+
 ```bash
-pip install -e .[dev]
-pytest tests/ -v
-ruff check .
+pre-commit run --all-files
 ```
 
 ## Acknowledgements

{diffpdf-0.3.2 → diffpdf-1.1.0}/README.md

@@ -4,6 +4,7 @@
 [![codecov](https://codecov.io/gh/JustusRijke/DiffPDF/graph/badge.svg?token=O3ZJFG6X7A)](https://codecov.io/gh/JustusRijke/DiffPDF)
 [![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue)](https://www.python.org/downloads/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![PyPI - Version](https://img.shields.io/pypi/v/DiffPDF)](https://pypi.org/project/DiffPDF/)
 [![PyPI - Downloads](https://img.shields.io/pypi/dw/DiffPDF)](https://pypi.org/project/DiffPDF/)
 
 CLI tool for detecting structural, textual, and visual differences between PDF files, for use in automatic regression tests.
@@ -21,12 +22,15 @@ Each stage only runs if all previous stages pass.
 
 ## Installation
 
+Install Python (v3.10 or higher) and install the package:
+
 ```bash
 pip install diffpdf
 ```
 
 ## CLI Usage
-```
+
+```bash
 Usage: diffpdf [OPTIONS] REFERENCE ACTUAL
 
   Compare two PDF files for structural, textual, and visual differences.
@@ -34,13 +38,13 @@ Usage: diffpdf [OPTIONS] REFERENCE ACTUAL
 Options:
   --threshold FLOAT       Pixelmatch threshold (0.0-1.0)
   --dpi INTEGER           Render resolution
-  --output-dir DIRECTORY  Diff image output directory (optional, if not specified no diff images are saved)
+  --output-dir DIRECTORY  Diff output directory (saves text diffs and visual diff images on failure)
   -v, --verbose           Increase verbosity
   --version               Show the version and exit.
   --help                  Show this message and exit.
 ```
 
-**Exit Codes**
+### Exit Codes
 
 - `0` — Pass (PDFs are equivalent)
 - `1` — Fail (differences detected)
@@ -51,19 +55,44 @@ Options:
 ```python
 from diffpdf import diffpdf
 
-# Basic usage (no diff images saved)
+# Basic usage (no diff output saved)
 diffpdf("reference.pdf", "actual.pdf")
 
-# With options (save diff images to ./output directory)
-diffpdf("reference.pdf", "actual.pdf", output_dir="./output", threshold=0.2, dpi=150, verbose=True)
+# With options (save text diffs and visual diff images to ./output directory)
+diffpdf("reference.pdf", "actual.pdf", output_dir="./output", dpi=300)
 ```
 
 ## Development
 
+Install [uv](https://github.com/astral-sh/uv?tab=readme-ov-file#installation). Then, install dependencies & activate the automatically generated virtual environment:
+
+```bash
+uv sync --locked
+source .venv/bin/activate
+```
+
+Skip `--locked` to use the newest dependencies (this might modify `uv.lock`)
+
+### Testing
+
+Run tests:
+
+```bash
+pytest
+```
+
+### Quality Assurance (QA)
+
+Automatically run code quality checks before every commit using [pre-commit](https://pre-commit.com/):
+
+```bash
+pre-commit install
+```
+
+This installs git hooks that run ruff, type checks, and other checks before each commit. You can run manually at any time with:
+
 ```bash
-pip install -e .[dev]
-pytest tests/ -v
-ruff check .
+pre-commit run --all-files
 ```
 
 ## Acknowledgements

diffpdf-1.1.0/pyproject.toml

@@ -0,0 +1,76 @@
+[build-system]
+requires = [
+    "hatchling",
+    "hatch-vcs",
+]
+build-backend = "hatchling.build"
+
+[project]
+name = "diffpdf"
+dynamic = ["version"]
+description = "A tool for comparing PDF files"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{name = "Justus Rijke", email="justusrijke@gmail.com"}]
+requires-python = ">=3.10.0"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Development Status :: 5 - Production/Stable",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX :: Linux",
+    "Typing :: Typed",
+]
+dependencies = [
+    "click>=8",
+    "pymupdf>=1.23.0",
+    "pixelmatch-fast>=1.3.1",
+    "Pillow>=10.0.0",
+    "pre-commit>=4.5.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/JustusRijke/DiffPDF"
+Issues = "https://github.com/JustusRijke/DiffPDF/issues"
+
+[dependency-groups]
+dev = [
+    "pytest>=9",
+    "pytest-cov>=6",
+    "ruff>=0.10",
+    "ty>=0.0.8",
+]
+
+[project.scripts]
+diffpdf = "diffpdf.cli:cli"
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.version.raw-options]
+local_scheme = "no-local-version"
+
+[tool.pytest]
+strict = true
+testpaths = ["tests"]
+filterwarnings = ["error"] # Treat all warnings as errors (e.g., deprecation warnings)
+addopts = [
+    "-v",                           # Verbose output
+    "--cov",                        # Enable coverage 
+    "--cov-branch",                 # Make sure to cover every decision branch
+    "--cov-report=term-missing",    # Report which lines aren't covered
+    "--cov-report=xml",             # Dump to XML for Codecov
+]
+
+[tool.ruff.lint]
+extend-select = [
+    "I",    # Sort imports
+    "ANN",  # Enforce type annotations
+    "PT",   # Common style issues or inconsistencies with pytest-based tests
+]
+
+[tool.ruff.lint.isort]
+combine-as-imports = true # Combines "as" imports on the same line
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["ANN"] # Do not enforce type annotations for tests

{diffpdf-0.3.2 → diffpdf-1.1.0}/src/diffpdf/__init__.py

@@ -35,7 +35,7 @@ def diffpdf(
         return False
 
     logger.info("[3/4] Checking text content...")
-    if not check_text_content(ref_path, actual_path):
+    if not check_text_content(ref_path, actual_path, out_path):
         return False
 
     logger.info("[4/4] Checking visual content...")

{diffpdf-0.3.2 → diffpdf-1.1.0}/src/diffpdf/text_check.py

@@ -33,7 +33,7 @@ def generate_diff(
     return diff
 
 
-def check_text_content(ref: Path, actual: Path) -> bool:
+def check_text_content(ref: Path, actual: Path, output_dir: Path | None) -> bool:
     logger = logging.getLogger()
     # Extract text and remove whitespace
     ref_text = re.sub(r"\s+", " ", extract_text(ref)).strip()
@@ -42,6 +42,12 @@ def check_text_content(ref: Path, actual: Path) -> bool:
     if ref_text != actual_text:
         diff = generate_diff(ref_text, ref, actual_text, actual)
         diff_text = "\n".join(diff)
+
+        if output_dir is not None:
+            output_dir.mkdir(parents=True, exist_ok=True)
+            diff_file = output_dir / f"{ref.stem}_vs_{actual.stem}_text_diff.txt"
+            diff_file.write_text(diff_text)
+
         logger.error(f"Text content mismatch:\n {diff_text}")
         return False
 

{diffpdf-0.3.2 → diffpdf-1.1.0}/tests/test_api.py

@@ -1,4 +1,3 @@
-# type: ignore
 from pathlib import Path
 
 import pytest
@@ -9,7 +8,7 @@ TEST_ASSETS_DIR = Path(__file__).parent / "assets"
 
 
 @pytest.mark.parametrize(
-    "ref_pdf_rel,actual_pdf_rel,should_pass",
+    ("ref_pdf_rel", "actual_pdf_rel", "should_pass"),
     [
         # Pass cases
         ("pass/identical-A.pdf", "pass/identical-B.pdf", True),
@@ -29,3 +28,15 @@ def test_api(ref_pdf_rel, actual_pdf_rel, should_pass):
     result = diffpdf(ref_pdf, actual_pdf)
 
     assert result == should_pass
+
+
+def test_text_diff_output(tmp_path):
+    ref_pdf = TEST_ASSETS_DIR / "fail/1-letter-diff-A.pdf"
+    actual_pdf = TEST_ASSETS_DIR / "fail/1-letter-diff-B.pdf"
+
+    result = diffpdf(ref_pdf, actual_pdf, output_dir=tmp_path)
+
+    assert result is False
+    diff_file = tmp_path / "1-letter-diff-A_vs_1-letter-diff-B_text_diff.txt"
+    assert diff_file.exists()
+    assert diff_file.read_text()

{diffpdf-0.3.2 → diffpdf-1.1.0}/tests/test_cli.py

@@ -1,4 +1,3 @@
-# type: ignore
 from pathlib import Path
 
 from click.testing import CliRunner