Repository files navigation

pypdf is a free and open-source pure-python PDF library capable of splitting,merging,cropping, and transformingthe pages of PDF files. It can also addcustom data, viewing options, andpasswordsto PDF files. pypdf canretrieve textandmetadatafrom PDFs as well.

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

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 toprevious versions. Please refer tothe migrationguide formore information.

frompypdfimportPdfReaderreader=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 creatingannotations, decrypting and encrypting, and more. Check outthedocumentation for additional usageexamples!

For questions and answers, visitStackOverflow(tagged withpypdf).

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

The experience pypdf users have covers the whole range from beginners whowant to make their live easier to experts who developed software before PDFexisted. You can contribute to the pypdf community by answering questionsonStackOverflow,helping indiscussions,and asking users who report issues forMCVE's (Code + example PDF!).

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 occuras well as the code you're executing with all of the output. Useprint(pypdf.__version__) to tell us which version you're using.

All code contributions are welcome, but smaller ones have a better chance toget included in a timely manner. Adding unit tests for new features or testcases 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 withpytest:

$ pytest=====================test session starts =====================platform linux -- Python 3.6.15, pytest-7.0.1, pluggy-1.0.0rootdir: /home/moose/GitHub/Martin/pypdfplugins: cov-3.0.0collected 233 itemstests/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 warningin 4.52s ==========