pypdf README

The project's README from github.com/py-pdf/pypdf. As one markdown file: README.md.

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 ==========

pypdf (py-pdf/pypdf)

parsing
Searching Database…

10.3K ·GitHub
Pypdf
What is this?A free and open-source pure-python PDF library: it splits, merges, crops and transforms the pages of PDF files, and can add custom data, viewing options and passwords to them.
Is it a library I import in my code, or a program I run?A library: you import pypdf in your own Python code and call its functions — nothing runs on its own, and there is no GUI or command to launch.
How do I add it to a project?One command: 'pip install pypdf'.
Does it need anything else installed to work?The core is pure-python, so no PDF engines or system tools are needed. The one exception: AES encryption and decryption pull in extra dependencies.
Any version quirks I should know about?pypdf 3.1.0 and above include significant improvements over previous versions, so check the migration guide if you are coming from an older release.
Can it pull text out of a PDF?Yes — text extraction and metadata retrieval are built in alongside the page manipulation: pypdf can retrieve text and metadata from PDF files.
What else can it do to a PDF?It reads and creates annotations, and it can decrypt and encrypt documents — including password protection — on top of the split, merge and crop operations.
Is there a ready-made command-line tool built on it?Yes — pdfly is a separate CLI application that uses pypdf to interact with PDFs, so you can do common tasks without writing a script.
How mature is the project?It has been developed since 2012 and has over 10,000 GitHub stars. Maintenance is a collaborative effort that welcomes documentation, issue triage and code contributions.
What are similar projects?nativePDF-structurer, PyMuPDF, pdfplumber, liteparse, pdfcraft, paper-docx, TeamSync-PDF-Viewer, pdf-inspector
Which topics is it in?pdf-processing, pdf-parser, help-wanted, documents, minimal, annotation, metadata, parsing, text-processing, parser, python-library, document-processing
Creator
py-pdf
Size
42.8 MB
Stars
10.3K
Updated
CommitOct 17Release6.21.1Oct 17
Age
14y
Commits · 90 Days