Installation

Basic installation

pikepdf latest released version on PyPI

Most users on Linux, macOS or Windows with x64 systems should use pip to install pikepdf in their current Python environment (such as your project’s virtual environment).

pip install pikepdf

Use pip install --user pikepdf to install the package for the current user only. Use pip install pikepdf to install to a virtual environment.

Binary wheel availability

Python binary wheel availability

3.10

3.11

3.12

3.13

3.14

macOS 15.0+ Intel

✅

✅

✅

✅

✅

macOS 14.0+ Apple Silicon

✅

✅

✅

✅

✅

Windows x64

✅

✅

✅

✅

✅

manylinux2014 x64

✅

✅

✅

✅

✅

manylinux2014 aarch64 (ARM64)

✅

✅

✅

✅

✅

musllinux x64

✅

✅

✅

✅

✅

musllinux aarch64 (ARM64)

✅

✅

✅

✅

✅

  • ✅ wheels are available

  • ❌ wheels are not likely to be produced for this platform and Python version

  • ⏳ we are waiting on a third party to implement better support for this configuration

  • ⚠️ wheel is released but cannot be tested - use with caution

Binary wheels should work on most systems, provided a recent version of pip is used to install them. Old versions of pip, especially before 20.0, may fail to check appropriate versions.

macOS 14 or newer is typically required for binary wheels. Older versions may work if compiled from source.

Windows 7 or newer is required. Windows wheels include a recent copy of libqpdf.

Most Linux distributions support manylinux2014, with the notable except of [Alpine Linux], and older Linux distributions that do not have C++20-capable compilers. The Linux wheels include recent copies of libqpdf, libjpeg, and zlib.

Source builds are usually possible where binary wheels are available.

Platform support

Some platforms include versions of pikepdf that are distributed by the system package manager (such as apt). These versions may lag behind the version distributed with PyPI, but may be convenient for users that cannot use binary wheels.

Bento box containing sushi

Packaged fish.

Package status for python:pikepdf

Debian, Ubuntu and other APT-based distributions

apt install pikepdf

Fedora

Fedora Rawhide
dnf install python_pikepdf

Alpine Linux

Alpine Linux Edge
apk add py3-pikepdf

Installing on FreeBSD

pkg install py311-pikepdf

To attempt a manual install, try something like:

pkg install python3 py311-lxml py311-pip py311-pybind11 qpdf
pip install --user pikepdf

This procedure is known to work on FreeBSD 13.4 and 14.1.

PyPy3 support

We stopped generating binary wheels for PyPy3 after pikepdf 9.8.1 since some dependencies are reducing support for PyPy. You can use earlier versions or compile binary wheels from source.