PyMuPDF Documentation

Introduction
- Note on the Name fitz
- License and Copyright
- Covered Version
Installation
- Notes
- Install from source without using an sdist
- Enabling Integrated OCR Support
Tutorial
- Importing the Bindings
- Opening a Document
- Some Document Methods and Attributes
- Accessing Meta Data
- Working with Outlines
- Working with Pages
- PDF Maintenance
- Closing
- Further Reading
Recipes: Images
- How to Make Images from Document Pages
- How to Increase Image Resolution
- How to Create Partial Pixmaps (Clips)
- How to Zoom a Clip to a GUI Window
- How to Create or Suppress Annotation Images
- How to Extract Images: Non-PDF Documents
- How to Extract Images: PDF Documents
- How to Handle Image Masks
- How to Make one PDF of all your Pictures (or Files)
- How to Create Vector Images
- How to Convert Images
- How to Use Pixmaps: Glueing Images
- How to Use Pixmaps: Making a Fractal
- How to Interface with NumPy
- How to Add Images to a PDF Page
Recipes: Text
- How to Extract all Document Text
- How to Extract Text from within a Rectangle
- How to Extract Text in Natural Reading Order
- How to Extract Tables from Documents
- How to Mark Extracted Text
- How to Mark Searched Text
- How to Mark Non-horizontal Text
- How to Analyze Font Characteristics
- How to Insert Text
Recipes: Annotations
- How to Add and Modify Annotations
- How to Use FreeText
- Using Buttons and JavaScript
- How to Use Ink Annotations
Recipes: Drawing and Graphics
- Extracting Drawings
Recipes: Multiprocessing
Recipes: General
- How to Open with a Wrong File Extension
- How to Embed or Attach Files
- How to Delete and Re-Arrange Pages
- How to Join PDFs
- How to Add Pages
- How To Dynamically Clean Up Corrupt PDFs
- How to Split Single Pages
- How to Combine Single Pages
- How to Convert Any Document to PDF
- How to Deal with Messages Issued by MuPDF
- How to Deal with PDF Encryption
Recipes: Common Issues and their Solutions
- Changing Annotations: Unexpected Behaviour
  - Problem
  - Cause
  - Solutions
- Misplaced Item Insertions on PDF Pages
  - Problem
  - Cause
  - Solutions
- Missing or Unreadable Extracted Text
Recipes: Low-Level Interfaces
- How to Iterate through the xref Table
- How to Handle Object Streams
- How to Handle Page Contents
- How to Access the PDF Catalog
- How to Access the PDF File Trailer
- How to Access XML Metadata
- How to Extend PDF Metadata
- How to Read and Update PDF Objects
Recipes: Journalling
- Example Session 1
- Example Session 2
Module fitz
- Invocation
- Cleaning and Copying
- Extracting Fonts and Images
- Joining PDF Documents
- Low Level Information
- Embedded Files Commands
  - Information
  - Extraction
  - Deletion
  - Insertion
  - Updates
  - Copying
- Text Extraction
Classes
- Annot
  - Annotation Icons in MuPDF
  - Example
- Colorspace
- DisplayList
- Document
  - set_metadata() Example
  - set_toc() Demonstration
  - insert_pdf() Examples
  - Other Examples
- Font
- Identity
- IRect
- Link
- linkDest
- Matrix
  - Examples
  - Shifting
  - Flipping
  - Shearing
  - Rotating
- Outline
- Page
  - Modifying Pages
  - Description of get_links() Entries
  - Notes on Supporting Links
    - Reading (pertains to method get_links() and the first_link property chain)
    - Writing
  - Homologous Methods of Document and Page
- Pixmap
  - Supported Input Image Formats
  - Supported Output Image Formats
- Point
- Quad
  - Remark
  - Algebra and Containment Checks
- Rect
- Shape
  - Usage
  - Examples
  - Common Parameters
- TextPage
  - Structure of Dictionary Outputs
- TextWriter
- Tools
  - Example Session
- Widget
  - Standard Fonts for Widgets
  - Supported Widget Types
Operator Algebra for Geometry Objects
- General Remarks
- Unary Operations
- Binary Operations
- Some Examples
  - Manipulation with numbers
  - Manipulation with “like” Objects
Low Level Functions and Classes
- Functions
- Device
- Working together: DisplayList and TextPage
Glossary
Constants and Enumerations
- Constants
- Document Permissions
- PDF encryption method codes
- Font File Extensions
- Text Alignment
- Text Extraction Flags
- Link Destination Kinds
- Link Destination Flags
- Annotation Related Constants
- Widget Constants
- PDF Standard Blend Modes
- Stamp Annotation Icons
Color Database
- Function getColor()
- Printing the Color Database
Appendix 1: Details on Text Extraction
- General structure of a TextPage
- Plain Text
- BLOCKS
- WORDS
- HTML
- Controlling Quality of HTML Output
- DICT (or JSON)
- RAWDICT (or RAWJSON)
- XML
- XHTML
- Text Extraction Flags Defaults
- Performance
Appendix 2: Considerations on Embedded Files
- General
- MuPDF Support
- PyMuPDF Support
Appendix 3: Assorted Technical Information
- Image Transformation Matrix
- PDF Base 14 Fonts
- Adobe PDF References
- Using Python Sequences as Arguments in PyMuPDF
- Ensuring Consistency of Important Objects in PyMuPDF
- Design of Method Page.show_pdf_page()
  - Purpose and Capabilities
  - Technical Implementation
- Redirecting Error and Warning Messages
Change Log
Deprecated Names

Read the Docs v: stable

Versions: latest; stable

Downloads: pdf

On Read the Docs: Project Home; Builds