pdftabextract - A set of tools for data mining (OCR-processed) PDFs
IMPORTANT INITIAL NOTES
From time to time I receive emails from people trying to extract tabular data from PDFs. I'm fine with that and I'm glad to help. However, some people think that pdftabextract is some kind of magic wand that automatically extracts the data they want by simply running one of the provided examples on their documents. This, in the very most cases, won't work. I want to clear up a few things that you should consider before using this software and before writing an email to me:
- pdftabextract is not an OCR (optical character recognition) software. It requires scanned pages with OCR information, i.e. a "sandwich PDF" that contains both the scanned images and the recognized text. You need software like tesseract or ABBYY Finereader for OCR. In order to check if you have a "sandwich PDF", open your PDF and press "select all". This usually reveals the OCR-processed text information.
- pdftabextract is some kind of last resort when all other things fail for extracting tabular data from PDFs. Before trying this out, you should ask yourself the following questions:
- Is there really no other way / no other format for which the data is available?
- Can a special OCR software like ABBYY Finereader detect and extract the tables (you need to try this with a large sample of pages -- I found the table recognition in Finereader often unreliable)?
- Is it possible to extract the recognized text as-is from the PDFs and parse it? Try using the
pdftotexttool from poppler-utils, a package which is part of most Linux distributions and is also available for OSX via Homebrew or MacPorts:
pdftotext -layout yourdocument.pdf. This will create a file
yourdocument.txtcontaining the recognized text (from the OCR) with a layout that hopefully resembles your tables. Often, this can be parsed directly (e.g. with a Python script using regular expressions). If it can't be parsed (e.g. if the columns are not well separated in the text, the tables on each page are too different to each other in order to come up with a common structure for parsing, the pages are too skewed or rotated) then pdftabextract is the right software for you.
- pdftabextract is a set of tools. As such, it contains functions that are suitable for certain documents but not for others and many functions require you to set parameters that depend on the layout, scan quality, etc. of your documents. You can't just use the example scripts blindly with your data. You will need to adjust parameters in order that it works well with your documents. Below are some hints and explanations regarding those tools and their parameters.
This repository contains a set of tools written in Python 3 with the aim to extract tabular data from (OCR-processed) PDF files. Before these files can be processed they need to be converted to XML files in pdf2xml format. This is very simple -- see section below for instructions.
After that you can view the extracted text boxes with the pdf2xml-viewer tool if you like. The pdf2xml format can be loaded and parsed with functions in the
common submodule. Lines can be detected in the scanned images using the
imgproc module. If the pages are skewed or rotated, this can be detected and fixed with methods from
imgproc and functions in
textboxes. Lines or text box positions can be clustered in order to detect table columns and rows using the
clustering module. When columns and rows were successfully detected, they can be converted to a page grid with the
extract module and their contents can be extracted using
fit_texts_into_grid in the same module.
extract also allows you to export the data as pandas DataFrame.
If your scanned pages are double pages, you will need to pre-process them with
Examples and tutorials
- load and parse files in pdf2xml format (
- split scanned double pages (
- detect lines in scanned pages via image processing (
- detect page rotation or skew and fix it (
- detect clusters in detected lines or text box positions in order to find column and row positions (
- extract tabular data and convert it to pandas DataFrame (which allows export to CSV, Excel, etc.) (
This package is available on PyPI and can be installed via pip:
pip install pdftabextract
The requirements are listed in
requirements.txt and are installed automatically if you use pip.
Only Python 3 -- No Python 2 support.
Converting PDF files to XML files with pdf2xml format
You need to convert your PDFs using the poppler-utils, a package which is part of most Linux distributions and is also available for OSX via Homebrew or MacPorts. From this package we need the command
pdftohtml and can create an XML file in pdf2xml format in the following way using the Terminal:
pdftohtml -c -hidden -xml input.pdf output.xml
The arguments input.pdf and output.xml are your input PDF file and the created XML file in pdf2xml format respectively. It is important that you specifiy the -hidden parameter when you're dealing with OCR-processed ("sandwich") PDFs. You can furthermore add the parameters -f n and -l n to set only a range of pages to be converted.
Usage and examples
For usage and background information, please read my series of blog posts about data mining PDFs.
See the following images of the example input/output:
Detected clusters of vertical lines (columns)
Generated page grid viewed in pdf2xml-viewer
Excerpt of the extracted data
Apache License 2.0. See LICENSE file.