Update README in setup.py

main
Eric Ihli 4 years ago
parent 5a34d0a845
commit 7e5516eb5d

@ -0,0 +1,60 @@
# Table of Contents
This python package contains modules to help with finding and extracting tabular
data from a PDF or image into a CSV format.
Given an image that contains a table…
![img](resources/examples/example-page.png)
Extract the the text into a CSV format…
PRIZE,ODDS 1 IN:,# OF WINNERS*
$3,9.09,"282,447"
$5,16.66,"154,097"
$7,40.01,"64,169"
$10,26.67,"96,283"
$20,100.00,"25,677"
$30,290.83,"8,829"
$50,239.66,"10,714"
$100,919.66,"2,792"
$500,"6,652.07",386
"$40,000","855,899.99",3
1,i223,
Toa,,
,,
,,"* Based upon 2,567,700"
The package is split into modules with narrow focuses.
- `pdf_to_images` uses Poppler and ImageMagick to extract images from a PDF.
- `extract_tables` finds and extracts table-looking things from an image.
- `extract_cells` extracts and orders cells from a table.
- `ocr_image` uses Tesseract to OCR the text from an image of a cell.
- `ocr_to_csv` converts into a CSV the directory structure that `ocr_image` outputs.
The outputs of a previous module can be used by a subsequent module so that they
can be chained together to create the entire workflow, as demonstrated by the
following shell script.
#!/bin/sh
PDF=$1
python -m table_ocr.pdf_to_images $PDF | grep .png > /tmp/pdf-images.txt
cat /tmp/pdf-images.txt | xargs -I{} python -m table_ocr.extract_tables {} | grep table > /tmp/extracted-tables.txt
cat /tmp/extracted-tables.txt | xargs -I{} python -m table_ocr.extract_cells {} | grep cells > /tmp/extracted-cells.txt
cat /tmp/extracted-cells.txt | xargs -I{} python -m table_ocr.ocr_image {}
for image in $(cat /tmp/extracted-tables.txt); do
dir=$(dirname $image)
python -m table_ocr.ocr_to_csv $(find $dir/cells -name "*.txt")
done
The package was written in a [literate programming](https://en.wikipedia.org/wiki/Literate_programming) style. The source code at
<https://eihli.github.io/image-table-ocr/pdf_table_extraction_and_ocr.html> is
meant to act as the documentation and reference material.

@ -785,13 +785,13 @@ ocr_image(image, "--psm 7")
** setup.py ** setup.py
#+BEGIN_SRC python :tangle setup.py :results none #+BEGIN_SRC python :tangle setup.py :results none
import os
import setuptools import setuptools
long_description = """ this_dir = os.path.abspath(os.path.dirname(__file__))
Utilities for turning images of tables into CSV data. Uses Tesseract and OpenCV. with open(os.path.join(this_dir, "README.md"), encoding="utf-8") as f:
long_description = f.read()
Requires binaries for tesseract, ImageMagick, and pdfimages (from Poppler).
"""
setuptools.setup( setuptools.setup(
name="table_ocr", name="table_ocr",
version="0.2.1", version="0.2.1",

@ -1,10 +1,10 @@
import os
import setuptools import setuptools
long_description = """ this_dir = os.path.abspath(os.path.dirname(__file__))
Utilities for turning images of tables into CSV data. Uses Tesseract and OpenCV. with open(os.path.join(this_dir, "README.md"), encoding="utf-8") as f:
long_description = f.read()
Requires binaries for tesseract, ImageMagick, and pdfimages (from Poppler).
"""
setuptools.setup( setuptools.setup(
name="table_ocr", name="table_ocr",
version="0.2.1", version="0.2.1",

Loading…
Cancel
Save