Home

Welcome to the PyMuPDF wiki!

PyMuPDF (formerly known as python-fitz) is a Python binding for MuPDF - "a lightweight PDF and XPS viewer". MuPDF supports viewing files in PDF, XPS, OpenXPS and EPUB formats.
This binding provides access to the most important functions of MuPDF from within a Python environment.

MuPDF stands out among all similar products for its top rendering capability and unsurmounted processing speed.
You can testify this by yourself:
Try out and compare the various free PDF-viewers. In terms of speed and rendering quality SumatraPDF ranges at the top (apart from MuPDF's own viewer) - and it is based on MuPDF!

While these bindings have been available since several years for an earlier version of MuPDF (1.2), it was until only recently (mid May 2015), that its creator and a few co-workers decided to undertake the effort elevating this repository to the current release of MuPDF, which now counts at version 1.7a.
And we are determined to keep PyMuPDF current with future MuPDF releases!

This work is now completed: we are currently working on assembling a formal release.
You can use PyMuPDF today: just download this repository, the MuPDF source and perform a Python setup.

So, what do we have?

• A major part of the work was the creation of a new SWIG interface file to MuPDF. Once this was achieved, only minor bugs had to be fixed in order to get a stable, running Python environment.
• We have created demo scripts and example programs for typical use cases that you can take as templates for your development. Also do have a look at the tutorial, which is now part of the documentation.
• We have a simplified the setup procedure for Linux and Windows: there is no longer the need to build MuPDF yourself. Just download PyMuPDF and MyPDF and perform a Python setup.
• The other major effort was re-creating documentation to reflect a completely overhauled Python-MuPDF API (Which is now simpler and a lot less cryptic). We believe that it is now a lot easier to use the docu for creating your own application faster.

We invite you to join our efforts by contributing to these wikis, by testing what is there - and, of course, by submitting issues and bugs to this site!