Skip to main content

PyPI version Python Support GitHub last commit codecov

pypdf

pypdf is a free and open-source pure-python PDF library capable of splitting, merging, cropping, and transforming the pages of PDF files. It can also add custom data, viewing options, and passwords to PDF files. pypdf can retrieve text and metadata from PDFs as well.

See pdfly for a CLI application that uses pypdf to interact with PDFs.

Installation

Install pypdf using pip:

pip install pypdf

For using pypdf with AES encryption or decryption, install extra dependencies:

pip install pypdf[crypto]

NOTE: pypdf 3.1.0 and above include significant improvements compared to previous versions. Please refer to the migration guide for more information.

Usage

from pypdf import PdfReader

reader = PdfReader("example.pdf")
number_of_pages = len(reader.pages)
page = reader.pages[0]
text = page.extract_text()

pypdf can do a lot more, e.g. splitting, merging, reading and creating annotations, decrypting and encrypting. Check out the documentation for additional usage examples!

For questions and answers, visit StackOverflow (tagged with pypdf).

Contributions

Maintaining pypdf is a collaborative effort. You can support the project by writing documentation, helping to narrow down issues, and submitting code. See the CONTRIBUTING.md file for more information.

Q&A

The experience pypdf users have covers the whole range from beginner to expert. You can contribute to the pypdf community by answering questions on StackOverflow, helping in discussions, and asking users who report issues for MCVE's (Code + example PDF!).

Issues

A good bug ticket includes a MCVE - a minimal complete verifiable example. For pypdf, this means that you must upload a PDF that causes the bug to occur as well as the code you're executing with all of the output. Use print(pypdf.__version__) to tell us which version you're using.

Code

All code contributions are welcome, but smaller ones have a better chance to get included in a timely manner. Adding unit tests for new features or test cases for bugs you've fixed help us to ensure that the Pull Request (PR) is fine.

pypdf includes a test suite which can be executed with pytest:

$ pytest
===================== test session starts =====================
platform linux -- Python 3.6.15, pytest-7.0.1, pluggy-1.0.0
rootdir: /home/moose/GitHub/Martin/pypdf
plugins: cov-3.0.0
collected 233 items

tests/test_basic_features.py ..                         [  0%]
tests/test_constants.py .                               [  1%]
tests/test_filters.py .................x.....           [ 11%]
tests/test_generic.py ................................. [ 25%]
.............                                           [ 30%]
tests/test_javascript.py ..                             [ 31%]
tests/test_merger.py .                                  [ 32%]
tests/test_page.py .........................            [ 42%]
tests/test_pagerange.py ................                [ 49%]
tests/test_papersizes.py ..................             [ 57%]
tests/test_reader.py .................................. [ 72%]
...............                                         [ 78%]
tests/test_utils.py ....................                [ 87%]
tests/test_workflows.py ..........                      [ 91%]
tests/test_writer.py .................                  [ 98%]
tests/test_xmp.py ...                                   [100%]

========== 232 passed, 1 xfailed, 1 warning in 4.52s ==========

Download files

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

Source Distribution

pypdf-6.16.1.tar.gz (7.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pypdf-6.16.1-py3-none-any.whl (382.9 kB view details)

Uploaded Python 3

File details

Details for the file pypdf-6.16.1.tar.gz.

File metadata

  • Download URL: pypdf-6.16.1.tar.gz
  • Upload date:
  • Size: 7.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pypdf-6.16.1.tar.gz
Algorithm Hash digest
SHA256 c4d1b43ddae921387321cf63936cd16a7743b91d2da92f165c149a195c972ba9
MD5 c6bd7cc72cf95d7a96e3a8a1657ed952
BLAKE2b-256 b65adf92d1c1ef8806ca28f20f978ee059894868d93de797a7e2edebe7fe1a43

See more details on using hashes here.

Provenance

The following attestation bundles were made for pypdf-6.16.1.tar.gz:

Publisher: publish-to-pypi.yaml on py-pdf/pypdf

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pypdf-6.16.1-py3-none-any.whl.

File metadata

  • Download URL: pypdf-6.16.1-py3-none-any.whl
  • Upload date:
  • Size: 382.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pypdf-6.16.1-py3-none-any.whl
Algorithm Hash digest
SHA256 63fec31c4092ae50b6729beedcb469055b60d20c834bde1c402df241f371f644
MD5 fcb7720f4a953317a223baac3cc769d3
BLAKE2b-256 33a1724b18d6757ab7253a8fecd3a430eb8d980ed26872ba16651e7b5ddfc63f

See more details on using hashes here.

Provenance

The following attestation bundles were made for pypdf-6.16.1-py3-none-any.whl:

Publisher: publish-to-pypi.yaml on py-pdf/pypdf

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

6.16.2

2 files

This release

6.16.1 This release

2 files

6.16.0

2 files

6.15.0

2 files

6.14.2

2 files

6.14.1

2 files

6.14.0

2 files

6.13.3

2 files

6.13.2

2 files

6.13.1

2 files

6.13.0

2 files

6.12.2

2 files

6.12.1

2 files

6.12.0

2 files

6.11.0

2 files

6.10.2

2 files

6.10.1

2 files

6.10.0

2 files

6.9.2

2 files

6.9.1

2 files

6.9.0

2 files

6.8.0

2 files

6.7.5

2 files

6.7.4

2 files

6.7.3

2 files

6.7.2

2 files

6.7.1

2 files

6.7.0

2 files

6.6.2

2 files

6.6.1

2 files

6.6.0

2 files

6.5.0

2 files

6.4.2

2 files

6.4.1

2 files

6.4.0

2 files

6.3.0

2 files

6.2.0

2 files

6.1.3

2 files

6.1.2

2 files

6.1.1

2 files

6.1.0

2 files

6.0.0

2 files

5.9.0

2 files

5.8.0

2 files

5.7.0

2 files

5.6.1

2 files

5.6.0

2 files

5.5.0

2 files

5.4.0

2 files

5.3.1

2 files

5.3.0

2 files

5.2.0

2 files

5.1.0

2 files

5.0.1

2 files

5.0.0

2 files

4.3.1

2 files

4.3.0

2 files

4.2.0

2 files

4.1.0

2 files

4.0.2

2 files

4.0.1

2 files

4.0.0

2 files

3.17.4

2 files

3.17.3

2 files

3.17.2

2 files

3.17.1

2 files

3.17.0

2 files

3.16.4

2 files

3.16.3

2 files

3.16.2

2 files

3.16.1

2 files

3.16.0

2 files

3.15.5

2 files

3.15.4

2 files

3.15.3

2 files

3.15.2

2 files

3.15.1

2 files

3.15.0

2 files

3.14.0

2 files

3.13.0

2 files

3.12.2

2 files

3.12.1

2 files

3.12.0

2 files

3.11.1

2 files

3.11.0

2 files

3.10.0

2 files

3.9.1

2 files

3.9.0

2 files

3.8.1

2 files

3.8.0

2 files

3.7.1

2 files

3.7.0

2 files

3.6.0

2 files

3.5.2

2 files

3.5.1

2 files

3.5.0

2 files

3.4.1

2 files

3.4.0

2 files

3.3.0

2 files

3.2.1

2 files

3.2.0

2 files

3.1.0

2 files

1.13

1 file

1.12

1 file

1.11

1 file

1.10

1 file

1.9

1 file

1.8

1 file

1.7

1 file

1.6

1 file

1.5

1 file

1.4

1 file

1.3

1.2

1.1

1.0

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page