Read and write PDFs with Python, powered by qpdf

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for jrbarlow from gravatar.com jrbarlow

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: Mozilla Public License 2.0 (MPL 2.0)

Author: James R. Barlow

Requires: Python >=3.5

Classifiers

Project description

pikepdf
=======

**pikepdf** is a Python library for reading and writing PDF files.

.. |travis| image:: https://img.shields.io/travis/pikepdf/pikepdf/master.svg?label=Linux%2fmacOS%20build
:target: https://travis-ci.org/pikepdf/pikepdf
:alt: Travis CI build status (Linux and macOS)

.. |windows| image:: https://img.shields.io/appveyor/ci/jbarlow83/pikepdf/master.svg?label=Windows%20build
:target: https://ci.appveyor.com/project/jbarlow83/pikepdf
:alt: AppVeyor CI build status (Windows)

.. |pypi| image:: https://img.shields.io/pypi/v/pikepdf.svg
:target: https://pypi.org/project/pikepdf/
:alt: PyPI


|travis| |windows| |pypi|

pikepdf is based on `QPDF <https://github.com/qpdf/qpdf>`_, a powerful PDF
manipulation and repair library.

Python + QPDF = "py" + "qpdf" = "pyqpdf", which looks like a dyslexia test. Say it
out loud, and it sounds like "pikepdf".

.. code-block:: python

# Elegant, Pythonic API
pdf = pikepdf.open('input.pdf')
num_pages = len(pdf.pages)
del pdf.pages[-1]
pdf.save('output.pdf')

**To install:**

Python 3.5, 3.6 and 3.7 are fully supported.

.. code-block:: bash

pip install pikepdf

For users who want to build from source, see `installation <https://pikepdf.readthedocs.io/en/latest/index.html>`_.

pikepdf is `documented <https://pikepdf.readthedocs.io/en/latest/index.html>`_
and actively maintained. Commercial support is available.

Features
--------

This library is similar to PyPDF2 and pdfrw - it provides low level access to PDF
features and allows editing and content transformation of existing PDFs. Some
knowledge of the PDF specification may be helpful. It does not have the
capability to render a PDF to image.

Python 2.7 and earlier versions of Python 3 are not currently supported but
support is probably not difficult to achieve. Pull requests are welcome.

+---------------------------------------------------------------------+-----------------------+-------------------+-----------------+
| **Feature** | **pikepdf** | **PyPDF2** | **pdfrw** |
+---------------------------------------------------------------------+-----------------------+-------------------+-----------------+
| Editing, manipulation and transformation of existing PDFs | ✔ | ✔ | ✔ |
+---------------------------------------------------------------------+-----------------------+-------------------+-----------------+
| Based on an existing, mature PDF library | QPDF | ✘ | ✘ |
+---------------------------------------------------------------------+-----------------------+-------------------+-----------------+
| Implementation speed | C++ | Python | Python |
+---------------------------------------------------------------------+-----------------------+-------------------+-----------------+
| PDF versions supported | 1.1 to 1.7 | 1.3? | 1.7 |
+---------------------------------------------------------------------+-----------------------+-------------------+-----------------+
| Python versions supported | 3.5-3.7 | 2.6-3.6 | 2.6-3.6 |
+---------------------------------------------------------------------+-----------------------+-------------------+-----------------+
| Supports password protected (encrypted) PDFs | ✔ (except public key) | Only obsolete RC4 | ✘ |
+---------------------------------------------------------------------+-----------------------+-------------------+-----------------+
| Save and load PDF compressed object streams (PDF 1.5) | ✔ | ✘ | ✘ |
+---------------------------------------------------------------------+-----------------------+-------------------+-----------------+
| Creates linearized ("fast web view") PDFs | ✔ | ✘ | ✘ |
+---------------------------------------------------------------------+-----------------------+-------------------+-----------------+
| Actively maintained | |commits| | |pypdf2-commits| | |pdfrw-commits| |
+---------------------------------------------------------------------+-----------------------+-------------------+-----------------+
| Test suite coverage | ~86% | very low | unknown |
+---------------------------------------------------------------------+-----------------------+-------------------+-----------------+
| Creates PDFs that pass PDF validation tests | ✔ | ✘ | ? |
+---------------------------------------------------------------------+-----------------------+-------------------+-----------------+
| Modifies PDF/A without breaking PDF/A compliance | ✔ | ✘ | ? |
+---------------------------------------------------------------------+-----------------------+-------------------+-----------------+
| Automatically repairs PDFs with internal errors | ✔ | ✘ | ✘ |
+---------------------------------------------------------------------+-----------------------+-------------------+-----------------+
| Documentation | ✔ | ✘ | ✔ |
+---------------------------------------------------------------------+-----------------------+-------------------+-----------------+
| Integrates with Jupyter and IPython notebooks for rapid development | ✔ | ✘ | ✘ |
+---------------------------------------------------------------------+-----------------------+-------------------+-----------------+

License
-------

pikepdf is provided under the `Mozilla Public License 2.0
<https://www.mozilla.org/en-US/MPL/2.0/>`_ license (MPL) that can be found in
the LICENSE file. By using, distributing, or contributing to this project, you
agree to the terms and conditions of this license.

`Informally <https://www.mozilla.org/en-US/MPL/2.0/FAQ/>`_, MPL 2.0 is a not a
"viral" license. It may be combined with other work, including commercial
software. However, you must disclose your modifications *to pikepdf* in source
code form. In other works, fork this repository on GitHub or elsewhere and
commit your contributions there, and you've satisfied your obligations.
MPL 2.0 is compatible with the GPL and LGPL - see the
`guidelines <https://www.mozilla.org/en-US/MPL/2.0/combining-mpl-and-gpl/>`_
for notes on use in GPL.

The ``tests/resources/copyright`` file describes licensing terms for the test
suite and the provenance of test resources.


.. |commits| image:: https://img.shields.io/github/commit-activity/y/pikepdf/pikepdf.svg
:target: https://github.com/pikepdf/pikepdf/graphs/commit-activity

.. |pypdf2-commits| image:: https://img.shields.io/github/commit-activity/y/mstamy2/PyPDF2.svg
:target: https://github.com/mstamy2/PyPDF2/graphs/commit-activity

.. |pdfrw-commits| image:: https://img.shields.io/github/commit-activity/y/pmaupin/pdfrw.svg
:target: https://github.com/pmaupin/pdfrw/graphs/commit-activity


Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for jrbarlow from gravatar.com jrbarlow

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: Mozilla Public License 2.0 (MPL 2.0)

Author: James R. Barlow

Requires: Python >=3.5

Classifiers

Release history Release notifications | RSS feed

8.15.1

8.15.0

8.14.0

8.13.0

8.12.0

8.11.2

8.11.1

8.11.0

8.10.1

8.10.0

8.9.0

8.8.0

8.7.1

8.7.0

8.6.0

8.5.3

8.5.2

8.5.1

8.5.0

8.4.2.dev2 pre-release

8.4.2.dev1 pre-release

8.4.1

8.4.0

8.3.2

8.3.1

8.3.0

8.2.3

8.2.2

8.2.1

8.2.0

8.1.1

8.0.0

8.0.0rc3 pre-release

8.0.0rc2 pre-release

7.2.0

7.1.2

7.1.1

7.1.0

7.0.0

7.0.0rc2 pre-release

7.0.0rc1 pre-release

6.2.9

6.2.8.post1

6.2.8 yanked

Reason this release was yanked:

PyPI quote exceeded so not all wheels uploaded

6.2.7

6.2.6

6.2.5

6.2.4

6.2.3

6.2.2

6.2.1

6.2.0

6.1.0

6.0.2

6.0.1

6.0.0.post2

6.0.0.post1 yanked

Reason this release was yanked:

Use .post2

5.6.1

5.6.0

5.5.0

5.4.2

5.4.1

5.4.0

5.3.2

5.3.1

5.3.0

5.2.0

5.1.5.post1

5.1.5

5.1.4.post1

5.1.4

5.1.3

5.1.2

5.1.1

5.1.0

5.0.1

5.0.0

4.5.0

4.4.1

4.4.0

4.3.1

4.3.0

4.2.0

4.1.0

4.0.2

4.0.1.post1

4.0.1

4.0.0

3.2.0

3.1.1

3.1.0

3.0.0

3.0.0b3 pre-release

3.0.0b2 pre-release

3.0.0b1 pre-release

2.16.1

2.16.0

2.15.1

2.15.0

2.14.2

2.14.1

2.14.0

2.13.0

2.12.2

2.12.1

2.12.0

2.11.4

2.11.3

2.11.2

2.11.1

2.11.0

2.10.0

2.9.2

2.9.1

2.9.0

2.8.0.post2

2.8.0.post1

2.8.0

2.7.0

2.6.0

2.5.2

2.5.1

2.5.0

2.4.0

2.3.0

2.2.5

2.2.4

2.2.3

2.2.2

2.2.1

2.2.0

2.1.2

2.1.1

2.1.0

2.0.0

2.0.0b2 pre-release

2.0.0b1 pre-release

1.19.4

1.19.3

1.19.2

1.19.1

1.19.0

1.18.0

1.17.3

1.17.2

1.17.1

1.17.0

1.16.1

1.16.0

1.15.1

1.15.0

1.14.0

1.13.0

1.12.0

1.11.2

1.11.1

1.11.0

1.10.4

1.10.3

1.10.2

1.10.1

1.10.0

1.9.0

1.8.3

1.8.2

1.8.1

1.8.0

1.7.1

1.7.0

1.6.5

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.0.post0

1.5.0

1.4.0

1.3.1

1.3.0

1.2.0

1.1.0

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

0.10.2

0.10.1

0.10.0

0.9.2

0.9.1

0.9.0

0.3.7.post2

0.3.7.post1

0.3.7

0.3.6

0.3.5

0.3.4

This version

0.3.3

0.3.2

0.3.1

0.3.0

0.2.2

0.2.1

0.2.0

0.1.10

0.1.9

0.1.8

0.1.7

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0.post1

0.1.0

0.1rc5 pre-release

0.1rc4 pre-release

0.1rc3 pre-release

0.1rc2 pre-release

0.1rc1 pre-release

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pikepdf-0.3.3.tar.gz (1.9 MB view hashes)

Uploaded Source

Built Distributions

pikepdf-0.3.3-cp37-cp37m-win_amd64.whl (859.4 kB view hashes)

Uploaded CPython 3.7m Windows x86-64

pikepdf-0.3.3-cp37-cp37m-manylinux1_x86_64.whl (7.1 MB view hashes)

Uploaded CPython 3.7m

pikepdf-0.3.3-cp37-cp37m-macosx_10_6_intel.whl (1.0 MB view hashes)

Uploaded CPython 3.7m macOS 10.6+ intel

pikepdf-0.3.3-cp36-cp36m-win_amd64.whl (859.3 kB view hashes)

Uploaded CPython 3.6m Windows x86-64

pikepdf-0.3.3-cp36-cp36m-manylinux1_x86_64.whl (7.1 MB view hashes)

Uploaded CPython 3.6m

pikepdf-0.3.3-cp36-cp36m-macosx_10_6_intel.whl (1.0 MB view hashes)

Uploaded CPython 3.6m macOS 10.6+ intel

pikepdf-0.3.3-cp35-cp35m-win_amd64.whl (859.3 kB view hashes)

Uploaded CPython 3.5m Windows x86-64

pikepdf-0.3.3-cp35-cp35m-manylinux1_x86_64.whl (7.1 MB view hashes)

Uploaded CPython 3.5m

pikepdf-0.3.3-cp35-cp35m-macosx_10_6_intel.whl (1.0 MB view hashes)

Uploaded CPython 3.5m macOS 10.6+ intel

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page