Skip to main content

pdfpecker for Python

Fast HTML and Markdown to PDF, and PDF to images and text, for Python. No browser, no dependencies, no .NET to install.

pip install pdfpecker
import pdfpecker

pdf = pdfpecker.html_to_pdf("<h1>Invoice 42</h1><p>Total: <b>1,250.00 EUR</b></p>")
pdfpecker.html_file_to_pdf("templates/invoice.html", "invoice.pdf")     # images and CSS resolve next to the file
pdfpecker.markdown_file_to_pdf("README.md", "readme.pdf")

pngs = pdfpecker.pdf_to_images(pdf, dpi=96)        # one PNG per page (or format="jpeg"/"webp")
text = pdfpecker.pdf_to_text(pdf)                  # pages separated by \f
both = pdfpecker.merge_pdfs([pdf, "terms.pdf"])

This is the PdfPecker .NET library, compiled ahead of time into a native library that ships inside the wheel. PdfPecker has its own HTML parser, CSS engine, layout engine, PDF writer and PDF renderer, so a conversion takes about a millisecond for a one-page invoice and never starts a browser. The package version is the library version it holds. Documentation of what PdfPecker renders, its CSS support and its limitations: pdfpecker.net/docs.

Platforms

Wheels for Linux (glibc 2.28+ and musl, x86-64 and ARM64), macOS (Apple Silicon and Intel) and Windows (x64 and ARM64), on Python 3.9 and later. Each wheel is about 9 MB and has no Python or system dependencies.

Speed

From Python, on a 4-core Linux cloud VM, median time per document after warm-up; the documents are the benchmark pages of the PdfPecker repository:

Invoice, 1 page Feature tour, 5 pages Report, 29 pages Start-up and first PDF Peak memory, one PDF
pdfpecker 0.7 ms 2.9 ms 32 ms 57 ms 32 MB
Chromium 153 via Playwright 24 ms 48 ms 290 ms 735 ms 542 MB
xhtml2pdf 0.2.28 33 ms 209 ms 2.9 s 453 ms 63 MB
WeasyPrint 70.0 324 ms 797 ms 4.2 s 1.1 s 75 MB

API

Every function takes bytes or a path for PDFs, raises a subclass of PdfPeckerError on failure, is thread-safe and releases the GIL while it works, so threads convert in parallel.

Function Returns
html_to_pdf(html, **options) PDF bytes from an HTML str or UTF-8 bytes
html_file_to_pdf(path, output=None, **options) PDF bytes, also written to output when given; base_dir is the file's folder
markdown_to_pdf(markdown, **options) PDF bytes from CommonMark with GitHub tables, task lists, strikethrough and footnotes
markdown_file_to_pdf(path, output=None, **options) as html_file_to_pdf
pdf_to_images(pdf, dpi=150, format="png", pages=None, width=None, height=None, transparent=False, quality=None, password=None) a list of encoded images, one per page
pdf_to_text(pdf, pages=None, password=None) the text in reading order, pages separated by \f
pdf_to_text_pages(pdf, pages=None, password=None) a list with the text of each page
pdf_to_markdown(pdf, pages=None, include_links=True, include_annotations=True, include_images=False, page_comments=False, max_pages=None, password=None) GitHub Flavored Markdown of any PDF: headings, lists and tables in reading order, for search indexes and language models
pdf_page_count(pdf, password=None) the number of pages
merge_pdfs(pdfs, title=None, author=None, bookmarks=True, creation_date=None) one PDF from several
pdf_to_pdfa(pdf, output=None, conformance="PDF/A-2b") any PDF converted to PDF/A-2b, -2u, -3b or -3u, as a PdfAResult with pdf, changes, problems and is_conformant
library_version() the version of the PdfPecker library inside

pages takes a page number, a list of numbers, or a range such as "1-3,5", "8-" or "last", numbered from 1. Every function also takes timeout in seconds.

Options of the HTML and Markdown functions:

Option Meaning
base_dir The folder relative image, stylesheet and font paths resolve against. Without it, a document from a string loads no local files.
allow_file_access Let the document read files outside base_dir too. Only for HTML you trust.
page_size, landscape "A3", "A4" (default), "A5", "Letter", "Legal" or (width_mm, height_mm). A CSS @page { size } rule wins.
margin In points (72 per inch): one number or (top, right, bottom, left). Default 36. CSS @page { margin } wins.
scale, shrink_to_fit Zoom the content; shrink content wider than the page (on by default).
header_text, footer_text A line of text in the top or bottom margin; {page} and {pages} are replaced. CSS margin boxes (@top-center, ...) do more.
fonts, use_system_fonts TrueType/OpenType files or folders that CSS font-family can name; or look families up among the installed fonts.
title, author, subject, keywords, language Document properties.
user_style_sheet CSS applied after the document's own.
creation_date A fixed date (datetime, date or Unix seconds): the output is then byte-identical from run to run.
conformance "PDF/A-2b", "PDF/A-3b", "PDF/A-2u", "PDF/A-3u", "PDF/A-4" or "PDF/A-4f".
accessibility "tagged", "PDF/UA-1" or "PDF/UA-2".
compress, bookmarks, max_pages Compress streams (on); bookmarks from headings (on); stop beyond this many pages (100,000).

Errors: PdfPeckerArgumentError (also a ValueError) for bad options, PdfReadError for input that is not a readable PDF, PdfPasswordError, PdfLimitError for max_pages and the size limits, PdfTimeoutError (also a TimeoutError) and PdfFileError (also an OSError) for a font or file that cannot be read.

Using it from AI agents and skills

pdfpecker suits code that an agent writes and runs in a sandbox: one pip install, nothing to download at run time, no browser to launch, and errors that say what went wrong. A few things to tell the agent:

  • Write the document as HTML with CSS; put page size, margins, page numbers and running headers in @page rules, for example @page { size: A4; margin: 20mm; @bottom-center { content: "Page " counter(page) " of " counter(pages) } }.
  • There is no JavaScript: charts must be SVG or images, not a script that draws them.
  • Images, stylesheets and fonts load from base_dir (or data: URIs), never from the network.
  • The built-in fonts (Helvetica, Times and Courier, with bundled fallback fonts for the letters they lack) cover Latin, Greek and Cyrillic; other scripts come out as question marks. For Chinese, Japanese, Arabic, Hebrew, Hindi or Thai, pass fonts=[...] with a font that covers the script, or use_system_fonts=True.
  • To check a result, render it back with pdf_to_images(pdf, dpi=60) and look at the pages, or read it with pdf_to_text.

MCP server

The package includes a Model Context Protocol server, so chat apps and coding agents that speak MCP can make PDFs, look at their pages and read them. It runs over stdio and needs nothing but this package:

claude mcp add pdfpecker -- uvx pdfpecker mcp            # Claude Code

For Claude Desktop and other apps that read an mcpServers setting:

{ "mcpServers": { "pdfpecker": { "command": "uvx", "args": ["pdfpecker", "mcp", "--root", "/Users/me/Documents/pdfs"] } } }
Tool What it does
html_to_pdf HTML (inline or a file) to a PDF file, with previews of the first pages to check the layout
markdown_to_pdf the same for Markdown
render_pdf_pages PNG images of up to 20 pages, for the model to look at
pdf_to_text the text of a PDF, page by page
pdf_to_markdown any PDF as Markdown, returned or written to a file
pdf_to_pdfa any PDF converted to PDF/A, with what changed and what could not be fixed
pdf_info page count and file size
merge_pdfs several PDF files into one

The tools read and write files only inside the --root folders (repeatable), because the model picks the paths. The default is the current folder, or ~/PdfPecker when the server starts in the filesystem's root, as chat apps often do. python -m pdfpecker mcp runs the same server without uvx.

Building from source

The wheel's native library is built from the released PdfPecker NuGet package named in PDFPECKER_VERSION. It needs the .NET 10 SDK with the NativeAOT prerequisites (clang on Linux, Xcode on macOS, the Visual Studio C++ tools on Windows):

ci/build.sh linux-x64 manylinux_2_39_x86_64          # RID and wheel tag; builds, packs and tests the wheel

Or by hand: dotnet publish native/PdfPecker.Native.csproj -c Release -r linux-x64, copy pdfpecker_native.so (.dylib, .dll) into src/pdfpecker/, and run pytest. PDFPECKER_NATIVE_LIB points the package at a library elsewhere.

The C ABI (native/Exports.cs) is one function, pdfpecker_invoke(op, input, input_len, options_json, &output, &output_len, &error), plus pdfpecker_free, pdfpecker_version and pdfpecker_abi_version, so other languages with an FFI can use the same library.

Releasing

A PdfPecker release on NuGet is followed by a pull request here that changes PDFPECKER_VERSION. Once it is merged, the owner publishes a GitHub release tagged v<version>; the Wheels workflow builds the eight wheels again, checks the tag against PDFPECKER_VERSION and uploads them to PyPI with Trusted Publishing. It then lists the new version of the MCP server (server.json) in the official MCP Registry.

License

MIT. The wheel also contains the .NET runtime, zlib-ng and the fonts and data PdfPecker bundles, each under its own license: see THIRD-PARTY-NOTICES.md.

Metadata

Release files for pdfpecker 1.23.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for pdfpecker 1.23.0
File Actions
pdfpecker-1.23.0-py3-none-win_arm64.whl Python 3 none Windows ARM64 Details for pdfpecker-1.23.0-py3-none-win_arm64.whl
pdfpecker-1.23.0-py3-none-win_amd64.whl Python 3 none Windows x86-64 Details for pdfpecker-1.23.0-py3-none-win_amd64.whl
pdfpecker-1.23.0-py3-none-musllinux_1_2_x86_64.whl Python 3 none Linux musl 1.2+ x86-64 Details for pdfpecker-1.23.0-py3-none-musllinux_1_2_x86_64.whl
pdfpecker-1.23.0-py3-none-musllinux_1_2_aarch64.whl Python 3 none Linux musl 1.2+ ARM64 Details for pdfpecker-1.23.0-py3-none-musllinux_1_2_aarch64.whl
pdfpecker-1.23.0-py3-none-manylinux_2_28_x86_64.whl Python 3 none Linux glibc 2.28+ x86-64 Details for pdfpecker-1.23.0-py3-none-manylinux_2_28_x86_64.whl
pdfpecker-1.23.0-py3-none-manylinux_2_28_aarch64.whl Python 3 none Linux glibc 2.28+ ARM64 Details for pdfpecker-1.23.0-py3-none-manylinux_2_28_aarch64.whl
pdfpecker-1.23.0-py3-none-macosx_12_0_x86_64.whl Python 3 none macOS 12.0+ x86-64 Details for pdfpecker-1.23.0-py3-none-macosx_12_0_x86_64.whl
pdfpecker-1.23.0-py3-none-macosx_12_0_arm64.whl Python 3 none macOS 12.0+ ARM64 Details for pdfpecker-1.23.0-py3-none-macosx_12_0_arm64.whl

Total release size: 79.3 MB

Release files / pdfpecker-1.23.0-py3-none-win_arm64.whl

Download URL pdfpecker-1.23.0-py3-none-win_arm64.whl
Size 9.4 MB
Tags Python 3 Windows ARM64
SHA-256 checksum
How to use checksums
b0fb69797a8de9d55b4776ca7cb681db742b9ca10d72fdcc8b9c99bb846e6f6d
BLAKE2b-256 checksum
How to use checksums
358fb3ef8e987370270c9a9393d8aff6ebd28c988cd1d5909624afed860815c7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.

Transparency log

Release files / pdfpecker-1.23.0-py3-none-win_amd64.whl

Download URL pdfpecker-1.23.0-py3-none-win_amd64.whl
Size 9.7 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
581c12d645adffbc67db4629a4bb75c63d81ea9199c4f2336c6f95b14ee47d21
BLAKE2b-256 checksum
How to use checksums
9a50263f8ce5aa3da02dd5ecaf4d8ffcc9abf466dcee878bc37353725418f7da
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.

Transparency log

Release files / pdfpecker-1.23.0-py3-none-musllinux_1_2_x86_64.whl

Download URL pdfpecker-1.23.0-py3-none-musllinux_1_2_x86_64.whl
Size 10.3 MB
Tags Linux musl 1.2+ x86-64 Python 3
SHA-256 checksum
How to use checksums
86179a184cc0b269415213e98f630320e56e20f21c3b8dd2b245574f626a0c60
BLAKE2b-256 checksum
How to use checksums
d74ba50ee82588ac07b5ee1a978553d3590eedef58ae33235aeab7e37eb8364c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.

Transparency log

Release files / pdfpecker-1.23.0-py3-none-musllinux_1_2_aarch64.whl

Download URL pdfpecker-1.23.0-py3-none-musllinux_1_2_aarch64.whl
Size 9.9 MB
Tags Linux musl 1.2+ ARM64 Python 3
SHA-256 checksum
How to use checksums
d1c9f4ee7e235c15418509afcdd388b6f7cc44aa3bffacf290f72502b806457c
BLAKE2b-256 checksum
How to use checksums
441f58b65e5e9fc16d486afa1e927ade70bfaeb49c8d6af140b32c2bfe72d352
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.

Transparency log

Release files / pdfpecker-1.23.0-py3-none-manylinux_2_28_x86_64.whl

Download URL pdfpecker-1.23.0-py3-none-manylinux_2_28_x86_64.whl
Size 10.3 MB
Tags Linux glibc 2.28+ x86-64 Python 3
SHA-256 checksum
How to use checksums
434aabdfdd752de5476b7c9c423328356b442c94d5e002d6cea33a32ecbcde84
BLAKE2b-256 checksum
How to use checksums
24a84f80b657c1a45fce384d7815e79ba6581fadd820878e59eb317459bbdb6c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.

Transparency log

Release files / pdfpecker-1.23.0-py3-none-manylinux_2_28_aarch64.whl

Download URL pdfpecker-1.23.0-py3-none-manylinux_2_28_aarch64.whl
Size 9.9 MB
Tags Linux glibc 2.28+ ARM64 Python 3
SHA-256 checksum
How to use checksums
bf82111a02ad2aa7689561c4eee81039d293460c666ae62727186f8b4c6a345d
BLAKE2b-256 checksum
How to use checksums
b309968d6c7b1841b518ef43752a00e8c563e0ebe9dbade1e723276c21e9953d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.

Transparency log

Release files / pdfpecker-1.23.0-py3-none-macosx_12_0_x86_64.whl

Download URL pdfpecker-1.23.0-py3-none-macosx_12_0_x86_64.whl
Size 10.1 MB
Tags Python 3 macOS 12.0+ x86-64
SHA-256 checksum
How to use checksums
cac45244179ab0ea17b0533d563d3528057fa951edd56096b56b4ef24a5f35b2
BLAKE2b-256 checksum
How to use checksums
235a3500bd9efd92cf57723b337fef3a1afe0e673ef39e7e05a82dc84f6f97fc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.

Transparency log

Release files / pdfpecker-1.23.0-py3-none-macosx_12_0_arm64.whl

Download URL pdfpecker-1.23.0-py3-none-macosx_12_0_arm64.whl
Size 9.6 MB
Tags Python 3 macOS 12.0+ ARM64
SHA-256 checksum
How to use checksums
3ac7efa18bef0c2ec575b3fac68956cc54132b1537c47ad5bc74bbdf4863254a
BLAKE2b-256 checksum
How to use checksums
a15aba25d14c678afed8a685074dd8cd97152ca5258ae99fd2d65f86c8c05b98
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.

Transparency log

Security for pdfpecker 1.23.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 8 files in this release have been uploaded with provenance metadata.

Select from 8 files

Attestation for pdfpecker-1.23.0-py3-none-win_arm64.whl

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.23.0 This release

8 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page