Skip to main content

LLM-powered PDF table extractor

Project description

Tabulens

Tabulens is a Python package that intelligently extracts and restructures tables from PDF files using advanced computer vision and Large Language Models (LLMs). It automatically detects table structures, manages complex hierarchical tables, and exports data into structured formats like CSV and pandas DataFrames.

Features

  • 🔍 Automatic Table Detection: Uses computer vision to identify table regions.
  • 🧠 Intelligent Restructuring: Leverages LLMs to understand and restructure hierarchical tables.
  • 📊 Multiple Output Formats: Supports CSV and pandas DataFrame outputs.
  • 🎯 High Accuracy: Combines computer vision preprocessing with LLM analysis for robust extraction.
  • 🔧 Flexible Models: Supports both OpenAI GPT and Google Gemini models.
  • 📝 Hierarchy Preservation: Flattens nested tables while maintaining parent-child relationships.
  • 🚀 Easy to Use: Simple API and command-line interface.

Installation

From PyPI:

pip install tabulens

Or directly from GitHub:

pip install git+https://github.com/astonishedrobo/tabulens.git

Quick Start

Python API

from tabulens import TableExtractor

extractor = TableExtractor(
    model_name='gpt:gpt-4o-mini', # gemini:gemini-2.0-flash
    temperature=0.7
)

dfs = extractor.extract_tables(
    file_path='path/to/document.pdf',
    save=True,
    max_tries=3,
    print_logs=True
)

for i, df in enumerate(dataframes):
    if df is not None:
        print(f"Table {i+1}")
        print(df.head())

Command Line Interface

To extrach tables:

# OpenAI 
tabulens extract --pdf path/to/document.pdf --model gpt:gpt-4o-mini --temperature 0.7 --max_tries 3 --log

# Gemini
tabulens extract --pdf path/to/document.pdf --model gemini:gemini-2.0-flash --temperature 0.7 --max_tries 3 --log

CLI Options

  • --pdf: Path to the PDF file (required)
  • --model: Model name (gpt:gpt-4o-mini, gemini:gemini-2.0-flash, gpt:gpt-4o, gemini:gemini-2.5-flash-preview-05-20, etc.) [default: gpt:gpt-4o-mini]. For OpenAI models, use the prefix gpt:, and for Gemini models, use the prefix gemini:. (⚠️ Make sure to select models that support image inputs. You can use any of the mentioned examples for convenience.)
  • --temperature: Generation temperature (0.0-1.0) [default: 0.7]
  • --max_tries: Maximum retries per table extraction [default: 3] [Increase this value to enhance accuracy, as more attempts allow the system additional opportunities to correctly extract tables.]
  • --log: Print detailed logs

Environment Variable Setup

Before running the program, set the required API environment variables.

For CLI usage:

export OPENAI_API_KEY=<your_openai_api_key>
export GOOGLE_API_KEY=<your_google_api_key>

For Python API usage, load environment variables using python-dotenv:

from dotenv import load_dotenv
load_dotenv("path/to/.env")

Credits

Tabulens depends on these excellent open-source projects:

License

This project is licensed under the MIT License.

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

tabulens-0.1.4.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tabulens-0.1.4-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

Details for the file tabulens-0.1.4.tar.gz.

File metadata

  • Download URL: tabulens-0.1.4.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for tabulens-0.1.4.tar.gz
Algorithm Hash digest
SHA256 6e0e67a4b39f9dc6922acd7893545ffdf970610a5e45805f07d62612f34536bf
MD5 bb36da5d924e4f313bc012fb322412ca
BLAKE2b-256 135db57accbc0587108d9918106f5d68cf4257ad91a3b392b7abb353c9ec118b

See more details on using hashes here.

File details

Details for the file tabulens-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: tabulens-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 9.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for tabulens-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3fe33271953cc7686972e9f57db80276480a18e8f8225ea5ecd83165e56102a0
MD5 2b4f8d3b2deaea304bee83d5c76793d2
BLAKE2b-256 16625c2a45fc18bda19bf405e61f7949f3636a001261837ee3951a0099e9ed9d

See more details on using hashes here.

Supported by

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