Skip to main content

A pure-python PDF library capable of splitting, merging, cropping, and transforming PDF files

Project description

PyPI version Python Support GitHub last commit codecov

PyPDF2

PyPDF2 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. PyPDF2 can retrieve text and metadata from PDFs as well.

Installation

You can install PyPDF2 via pip:

pip install PyPDF2

Usage

from PyPDF2 import PdfReader

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

PyPDF2 can do a lot more, e.g. splitting, merging, reading and creating annotations, decrypting and encrypting, and more.

Please see the documentation and Scripts for more usage examples!

A lot of questions are asked and answered on StackOverflow.

Contributions

Maintaining PyPDF2 is a collaborative effort. You can support PyPDF2 by writing documentation, helping to narrow down issues, and adding code.

Q&A

The experience PyPDF2 users have covers the whole range from beginners who want to make their live easier to experts who developed software before PDF existed. You can contribute to the PyPDF2 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 PyPDF2, 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(PyPDF2.__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.

PyPDF2 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/PyPDF2
plugins: cov-3.0.0
collected 57 items

Tests/test_basic_features.py ..                                 [  3%]
Tests/test_merger.py .                                          [  5%]
Tests/test_page.py .                                            [  7%]
Tests/test_pagerange.py .......                                 [ 19%]
Tests/test_reader.py ..........                                 [ 36%]
Tests/test_utils.py ......................                      [ 75%]
Tests/test_workflows.py ..........                              [ 92%]
Tests/test_writer.py ..                                         [ 96%]
Tests/test_xmp.py ..                                            [100%]

========================= 57 passed in 1.06s ==========================

Project details


Download files

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

Source Distribution

PyPDF2-1.28.4.tar.gz (2.8 MB view details)

Uploaded Source

Built Distribution

PyPDF2-1.28.4-py3-none-any.whl (87.0 kB view details)

Uploaded Python 3

File details

Details for the file PyPDF2-1.28.4.tar.gz.

File metadata

  • Download URL: PyPDF2-1.28.4.tar.gz
  • Upload date:
  • Size: 2.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.64.0 importlib-metadata/4.2.0 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.4 CPython/3.6.15

File hashes

Hashes for PyPDF2-1.28.4.tar.gz
Algorithm Hash digest
SHA256 04ce42cd05707881fedbca3164744511805fe8c30618ae4cfb2b940e3368d5ad
MD5 ed811d19585dd6b035a69634731f83c0
BLAKE2b-256 dbe09f67b4b467362451157f3dcec0209c31b1861c692e9fff9afae7d8f37c83

See more details on using hashes here.

File details

Details for the file PyPDF2-1.28.4-py3-none-any.whl.

File metadata

  • Download URL: PyPDF2-1.28.4-py3-none-any.whl
  • Upload date:
  • Size: 87.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.64.0 importlib-metadata/4.2.0 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.4 CPython/3.6.15

File hashes

Hashes for PyPDF2-1.28.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7d80914ebb4cf93348d270f27a7a5eb741b912be63927da65c4c6b292c2f6b10
MD5 7c160f248a833408186f8760276fb726
BLAKE2b-256 b499be3bd6aba6770aec68792ce5bde5c88ec843b9415e71b967c0fadc22bdf9

See more details on using hashes here.

Supported by

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