An Introduction and Guide to Using PyMuPDF (Python Bindings for MuPDF)

PyMuPDF is a high‑performance Python library that provides bindings to the MuPDF rendering engine, enabling data extraction, conversion, and manipulation of PDF and other document formats.

MuPDF is a lightweight viewer for PDF, XPS, EPUB, CBZ, and other formats, offering high‑quality anti‑aliased rendering and support for many document types.

Installation

Install via pip with pip install PyMuPDF or use wheels for Windows, Linux, and macOS platforms.

Basic usage

Import the library with import fitz , check the version, open a document using doc = fitz.open(filename) , and access pages via page = doc.load_page(pno) or by iterating over the document.

Key features

Decrypt/encrypt files, extract text, images, metadata, and convert to formats such as PNG, SVG, HTML, JSON.

Command‑line utilities ( python -m fitz … ) for annotation, editing, and conversion.

Page rendering to raster images with page.get_pixmap() or vector images with page.get_svg_image() .

Text extraction with various options: "text", "blocks", "words", "html", "json", "xml", etc.

Search for text, retrieve links, annotations, and form fields.

Modify PDFs: insert, delete, move, copy, merge, split pages, and save with incremental updates.

Advanced operations

Use Document.insert_pdf() to merge PDFs, Document.save() with incremental=True for fast incremental saving, and Document.close() to release resources.