pdfminer.six

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.