Release date: June 20, 2018
This is version 1.13.11 of PyMuPDF (formerly python-fitz), a Python binding with support for MuPDF 1.13.0 - "a lightweight PDF and XPS viewer".
MuPDF can access files in PDF, XPS, OpenXPS, CBZ, EPUB and FB2 (e-books) formats, and it is known for its top performance and high rendering quality.
With PyMuPDF you therefore can also access files with extensions
*.epub from your Python scripts.
For all Windows and - thanks to our user @jbarlow83 - the major Mac OSX and Linux versions we offer wheel-based installation options. Look here to find the version for your OS. These files can also be found in the download section of PyPI.
If - for whatever reason - you need to generate PyMuPDF yourself, you must download and generate MuPDF before you can generate PyMuPDF. This process depends very much on your system. For most platforms, the MuPDF source contains prepared procedures to achieve this.
Be sure to download the official MuPDF release from here. MuPDF also has a GitHub repo, but this contains their current development source, which more often than not is incompatible with this PyMuPDF.
Once this is done, adjust directories in
setup.py and the rest should be as easy as running
python setup.py install.
The following sections contain some platform-specific comments, but please do refer to our documentation for more.
AUR: https://aur.archlinux.org/packages/python2-pymupdf/ currently only provides PyMuPDF version 1.9.2 for Python 2.
The required MuPDF version in the official Ubuntu repositories is often not timely available, so you do need to build it from source. Make sure to add
-fPIC to CFLAGS when compiling.
When MuPDF is ready, edit
setup.py in PyMuPDF and comment out the line of
library_dirs= to specify the directory which contains
libmupdf.a and other 3rd party libraries. Remove
setup.py if it complains. One of our users (thanks to @gileadslostson) has documented his MuPDF installation experience from sources in this Wiki page.
First, install the MuPDF headers and libraries, which are provided by mupdf-tools:
brew install mupdf-tools.
Then you might need to
export ARCHFLAGS='-arch x86_64', since
libmupdf.a is for x86_64 only.
Finally, please double check
setup.py before building. Update
library_dirs if necessary.
If you don't use
pip or PyPI, you can still download pre-generated binaries that are suitable for your Python / Windows combination. This, too, avoids any other download or compilation hassle. Again, make sure to consult our documentation.
If you do want to make your own binary however, have a look at this Wiki page. It explains how to use Visual Studio for generating MuPDF in quite some detail. Also do not hesitate to contact us if you need help.
Usage and Documentation
Our documentation, written using Sphinx, is available in various formats from the following sources.
- You can view it online at Read the Docs. For download, only use the following links.
- Windows CHM
Earlier versions are available in the releases directory.
PyMuPDF is distributed under GNU GPL V3. Because you will also be using MuPDF, its license GNU AFFERO GPL V3 applies as well. Copies of both licenses are included in this repository.
You can also find us on the Python Package Index PyPI.
Please note, that the project description there may be less up-to-date than the one you are currently looking at.
We invite you to join our efforts by contributing to the Wiki pages.
Please submit comments or issues here, or directly contact the authors.