Python bindings for MuPDF's rendering library.
Clone or download
Latest commit f4bca38 Nov 18, 2018

README.md

PyMuPDF 1.14.0

logo

Release date: November 15, 2018

Travis-CI: Build Status

On PyPI since August 2016:

Authors

Introduction

This is version 1.14.0 of PyMuPDF (formerly python-fitz), a Python binding with support for MuPDF 1.14.0 - "a lightweight PDF, XPS, and E-book 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 access files with extensions like ".pdf", ".xps", ".oxps", ".cbz", ".fb2" or ".epub" from your Python scripts.

See the Wiki for more information, news, release notes and usage recipes.

Installation

For all Windows and (thanks to our user @jbarlow83!) for the major Mac OSX and Linux versions we offer wheels. They can also be found in the download section of PyPI.

The platform tag for Mac OSX is macosx_10_6_intel.

The platform tag for Linux is manylinux1_x86_64, which makes these wheels usable on Debian, Ubuntu and most other variations.

On other operating systems you need to generate PyMuPDF yourself. And of course you can choose to do so for a wheel-supported platform, too. Before you can do this, you must download and generate MuPDF. This process depends very much on your system. For most platforms, the MuPDF source contains prepared procedures for achieving this.

  • Be sure to download the official MuPDF source release from here. Do not use MuPDF's GitHub repo. It contains their current development source, which is not compatible with this PyMuPDF version most of the time.

  • The repo's fitz folder contains a few files whose names start with an underscore. These files contain configuration data and hotfixes and each must be copy-renamed to its correct target location of the downloaded MuPDF source before you generate MuPDF. Currently, these files are:

    • fitz configuration file _mupdf_config.h copy-replace to mupdf/include/fitz/config.h.
    • fitz error module _error.c, copy-replace to mupdf/source/fitz/error.c.
    • PDF device module _pdf-device.c copy-replace mupdf/source/pdf/pdf-device.c.

Once this is done, adjust directories in setup.py and run python setup.py install.

The following sections contain further comments for some platforms.

Ubuntu

Our users (thanks to @gileadslostson and @jbarlow83!) have documented their MuPDF installation experiences from sources in this Wiki page.

OSX

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 include_dirs and library_dirs if necessary.

MS Windows

In addition to wheels, this platform offers pre-generated binaries in a ZIP format, which can be used without PIP.

If you are looking to make your own binary, consult this Wiki page. It explains how to use Visual Studio for generating MuPDF in quite some detail.

Usage and Documentation

For all document types you can render pages in raster (PNG) or vector (SVG) formats, extract text and access meta information, links, annotations and bookmarks, as well as decrypt the document. For PDF files, most of these objects can also be created, modified or deleted. Plus you can rotate, re-arrange, duplicate, create, or delete pages and join or split documents.

Specifically for PDF files, PyMuPDF provides update access to low-level structure data, supports handling of embedded files and modification of page contents (like inserting images, fonts, text, annotations and drawings).

Other features include embedding vector images (SVG, PDF) such as logos or watermarks, "posterizing" a PDF or creating "booklet" and "4-up" versions.

You can now also create and update Form PDFs and form fields with support for text, checkbox, listbox and combobox widgets.

Have a look at the basic demos, the examples (which contain complete, working programs), and the recipes section of our Wiki sidebar, which contains more than a dozen of guides in How-To-style.

Our documentation, written using Sphinx, is available in various formats from the following sources.

Earlier Versions

Earlier versions are available in the releases directory.

License

PyMuPDF is distributed under GNU GPL V3. Because you will implicitely also be using MuPDF, its license GNU AFFERO GPL V3 applies as well. Copies of both are included in this repository.

Contact

Please submit questions, comments or issues here, or directly contact the authors via their e-mail addresses.