Skip to main content

Convert PDF files to the archival PDF/A format

Project description

pdftopdfa

Python Version License

I built pdftopdfa as a free and open-source alternative to Ghostscript-based PDF/A converters. Ghostscript uses a dual license (AGPL/commercial) that makes it difficult to use in commercial products without purchasing a license. pdftopdfa is licensed under the permissive MPL-2.0 and can be freely used in commercial projects. Instead of re-rendering via Ghostscript, it modifies the PDF structure directly using pikepdf (based on QPDF), preserving the original content, fonts, and layout.

Highlights

  • No Ghostscript required -- direct PDF manipulation via pikepdf/QPDF
  • PDF/A-2b, 2u, 3b, 3u -- supports modern PDF/A levels (ISO 19005-2 and 19005-3)
  • Automatic font embedding -- uses policy-approved Windows system fonts or bundled replacements
  • Font subsetting -- reduces file size by removing unused glyphs
  • CJK support -- embeds Noto Sans CJK for Chinese, Japanese, and Korean text
  • ICC color profiles -- automatically embeds sRGB, CMYK, and grayscale profiles
  • Batch processing -- converts entire directories, optionally recursive
  • Integrated validation -- checks conformance via veraPDF
  • OCR support -- optional text recognition for scanned PDFs via Tesseract
  • Simple API -- usable as CLI tool or Python library

How It Works

pdftopdfa applies a multi-step conversion pipeline to make a PDF compliant with the PDF/A standard:

  1. Pre-check -- detects if the PDF is already a valid PDF/A file (skips conversion if the existing level meets or exceeds the target; optionally skips any veraPDF-compliant PDF/A via --skip-any-pdfa; see Usage Guide for details)
  2. OCR (optional) -- runs Tesseract via ocrmypdf on scanned pages without a text layer
  3. Font compliance -- analyzes all fonts, embeds missing ones, adds ToUnicode mappings, subsets embedded fonts, and fixes encoding issues
  4. Sanitization -- removes or fixes non-compliant elements (JavaScript, non-standard actions, transparency groups, annotations, optional content, etc.)
  5. Metadata -- synchronizes XMP metadata with the document info dictionary and sets the PDF/A conformance level
  6. Color profiles -- detects color spaces and embeds the required ICC profiles (sRGB, CMYK/FOGRA39, sGray)
  7. Save -- writes the output with the correct PDF version header

Installation

Prerequisites

  • Python 3.12, 3.13, or 3.14
  • macOS, Linux, or Windows
pip install pdftopdfa

Optional: OCR support

pip install "pdftopdfa[ocr]"

OCR requires a Tesseract installation on the system. See docs/ocr.md for details on OCR usage and quality presets.

Quick Start

# Simple conversion (creates document_pdfa.pdf)
pdftopdfa document.pdf

# Specific PDF/A level
pdftopdfa -l 2b document.pdf

# With validation
pdftopdfa -v document.pdf

# Skip any existing veraPDF-compliant PDF/A
pdftopdfa --skip-any-pdfa document.pdf

# Convert an entire directory
pdftopdfa -r ./documents/ ./output/

# OCR for scanned PDFs
pdftopdfa --ocr document.pdf

# Preserve known proprietary stamps as PDF Stamp annotations
pdftopdfa --preserve-stamps document.pdf
from pathlib import Path
from pdftopdfa import convert_to_pdfa

result = convert_to_pdfa(
    input_path=Path("input.pdf"),
    output_path=Path("output.pdf"),
    level="2b",
)

See docs/usage.md for the full CLI reference, Python API documentation, and examples.

Limitations

  • No PDF/A-1 support -- only PDF/A-2 and PDF/A-3 levels are supported
  • Encrypted PDFs -- password-protected PDFs cannot be converted
  • Font replacement -- fonts without a suitable metrically compatible replacement produce a warning; the resulting file may not be fully compliant

Font Sourcing

  • On Windows, pdftopdfa may automatically embed a conservative fixed allowlist of local fonts from %WINDIR%\Fonts.
  • A Windows system font is only used when the installed file lives under %WINDIR%\Fonts, its actual PostScript name is allowlisted, and its OpenType fsType permits outline embedding.
  • On macOS and Linux, system fonts are never auto-embedded; bundled replacement fonts are used instead.
  • fsType checks are a technical safeguard only and do not replace the font vendor's EULA or other license terms.
  • For auditable deployments, keep the allowlist tied to reviewed target systems or golden images.

Development

pip install -e ".[dev]"

Running Tests

pytest

The test suite contains 2600+ tests covering fonts, color profiles, metadata, sanitization, and end-to-end conversion.

Code Quality

ruff check src/ tests/   # Linting
ruff format src/ tests/  # Formatting

Documentation

Additional documentation is available in the docs/ folder:

Contributing

Contributions are welcome! Please open an issue to report bugs or suggest features, or submit a pull request.

Dependencies

Core:

  • pikepdf -- PDF manipulation (based on QPDF)
  • lxml -- XMP metadata processing
  • fonttools -- Font analysis, subsetting, and embedding
  • click -- CLI framework
  • colorama -- Colored terminal output
  • tqdm -- Progress bars

Optional:

Acknowledgments

This project bundles the following resources:

License

This project is licensed under the Mozilla Public License 2.0 or later (MPL-2.0+) -- see LICENSE for details.

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

pdftopdfa-0.3.15.tar.gz (20.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pdftopdfa-0.3.15-py3-none-any.whl (20.7 MB view details)

Uploaded Python 3

File details

Details for the file pdftopdfa-0.3.15.tar.gz.

File metadata

  • Download URL: pdftopdfa-0.3.15.tar.gz
  • Upload date:
  • Size: 20.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pdftopdfa-0.3.15.tar.gz
Algorithm Hash digest
SHA256 6d0907fa4097f7f5b4bb71be01788d0dedb7504a3c27fe3acf324bac496f58b6
MD5 e2c75134b7c504abe659fbd1695078af
BLAKE2b-256 df9181a5dd1ec49ae83effdcd57ea38322762ece92980baca53b395315d70db4

See more details on using hashes here.

Provenance

The following attestation bundles were made for pdftopdfa-0.3.15.tar.gz:

Publisher: publish.yml on iRedPaul/pdftopdfa

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pdftopdfa-0.3.15-py3-none-any.whl.

File metadata

  • Download URL: pdftopdfa-0.3.15-py3-none-any.whl
  • Upload date:
  • Size: 20.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pdftopdfa-0.3.15-py3-none-any.whl
Algorithm Hash digest
SHA256 4c1ea5543eedec60c8241f9c54a4f565b23bf18bfcd5f5842f198aef222527f6
MD5 a9333444c3c6c60a7ed5c7bfc6013496
BLAKE2b-256 96624b6e415e511ba18b418dc96958de23d7c39d836b9690ca7eaeed4ceac87c

See more details on using hashes here.

Provenance

The following attestation bundles were made for pdftopdfa-0.3.15-py3-none-any.whl:

Publisher: publish.yml on iRedPaul/pdftopdfa

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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