Skip to main content

pdfminer.six

Continuous integration PyPI version gitter

We fathom PDF

Pdfminer.six is a community maintained fork of the original PDFMiner. It is a tool for extracting information from PDF documents. It focuses on getting and analyzing text data. Pdfminer.six extracts the text from a page directly from the sourcecode of the PDF. It can also be used to get the exact location, font or color of the text.

It is built in a modular way such that each component of pdfminer.six can be replaced easily. You can implement your own interpreter or rendering device that uses the power of pdfminer.six for other purposes than text analysis.

Check out the full documentation on Read the Docs.

Features

  • Written entirely in Python.
  • Parse, analyze, and convert PDF documents.
  • Extract content as text, images, html or hOCR.
  • Support for PDF-1.7 specification (well, almost).
  • Support for CJK languages and vertical writing.
  • Support for various font types (Type1, TrueType, Type3, and CID) support.
  • Support for extracting embedded images (JPG, PNG, TIFF, JBIG2, bitmaps).
  • Support for decoding various compressions (ASCIIHexDecode, ASCII85Decode, LZWDecode, FlateDecode, RunLengthDecode, CCITTFaxDecode)
  • Support for RC4 and AES encryption.
  • Support for AcroForm interactive form extraction.
  • Table of contents extraction.
  • Tagged contents extraction.
  • Automatic layout analysis.

How to use

  • Install Python 3.10 or newer.

  • Install pdfminer.six.

    pip install pdfminer.six
    
  • (Optionally) install extra dependencies for extracting images.

    pip install 'pdfminer.six[image]'
    
  • Use the command-line interface to extract text from pdf.

    pdf2txt.py example.pdf
    
  • Or use it with Python.

    from pdfminer.high_level import extract_text
    
    text = extract_text("example.pdf")
    print(text)
    

Contributing

We welcome contributions! Whether you want to fix a bug, add a feature, or improve documentation, your help is appreciated.

Please note that as a community-maintained project with limited maintainer availability, the best way to get an issue resolved is to submit a pull request yourself.

To get started:

  1. Read CONTRIBUTING.md for setup instructions and coding standards
  2. Check out the open issues to find something to work on
  3. Join the discussion on Gitter if you have questions

Acknowledgement

This repository includes code from pyHanko ; the original license has been included here.

Metadata

Release files for pdfminer.six 20251230

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pdfminer.six 20251230
File Size Uploaded
pdfminer_six-20251230.tar.gz 8.5 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for pdfminer.six 20251230
File Interpreter ABI Platform
pdfminer_six-20251230-py3-none-any.whl Python 3 none any Details

Total release size: 15.1 MB

Release files / pdfminer_six-20251230.tar.gz

Download URL pdfminer_six-20251230.tar.gz
Size 8.5 MB
Tags Source
SHA-256 checksum
How to use checksums
e8f68a14c57e00c2d7276d26519ea64be1b48f91db1cdc776faa80528ca06c1e
BLAKE2b-256 checksum
How to use checksums
469ad79d8fa6d47a0338846bb558b39b9963b8eb2dfedec61867c138c1b17eeb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / pdfminer_six-20251230-py3-none-any.whl

Download URL pdfminer_six-20251230-py3-none-any.whl
Size 6.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
9ff2e3466a7dfc6de6fd779478850b6b7c2d9e9405aa2a5869376a822771f485
BLAKE2b-256 checksum
How to use checksums
65d7b288ea32deb752a09aab73c75e1e7572ab2a2b56c3124a5d1eb24c62ceb3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page