Skip to main content

Extracts HTML tables and converts them to Markdown, preserving structure via row/colspan handling.

Project description

html-table-rescuer

A robust Python tool to extract complex HTML tables and convert them into clean Markdown, JSON, or CSV formats.

Unlike simple formatters, this library features a Grid Logic Solver that correctly interprets rowspan and colspan attributes, normalizing complex HTML grids into perfectly aligned data structures.

How is this different from other table2md packages?

There is an existing package called table2md on PyPI.

  • The existing package is a formatter. You feed it Python lists/dicts, and it draws a Markdown table.

  • This package is an extractor and parser. It takes raw HTML source code, uses BeautifulSoup to parse the tags, mathematically resolves complex cell spans (rowspans/colspans), and builds an internal representation before exporting to Markdown.

The Problem:

Most parsers turn this <td rowspan="2"> into a misaligned mess:

| Header | Value |
|---|---|
| Spanned | Row 1 |
| Row 2 | |   <-- Everything shifts!

The Solution:

html-table-rescuer uses a grid solver to correctly normalize the matrix:

| Header | Value |
|---|---|
| Spanned | Row 1 |
| dito (Spanned) | Row 2 |

Architecture

Our pipeline ensures that complex HTML structures are safely converted without data loss or misalignment:

graph TD
    n1["HTML Input"] --> n2["BeautifulSoup Parser"]
    n2 --> n3["Grid Logic<br>(Rowspan/Colspan Solver)"]
    n3 --> n4["ParsedTable Data Object"]
    n4 --> n5["Markdown Export"]
    n4 --> n6["JSON/CSV Export"]
    n4 --> n7["LangChain/LlamaIndex Wrappers"]

Installation

pip install html-table-rescuer

(The import name stays table2md.)

Quick Start

from table2md import TableParser

html_content = """
<table border="1">
  <tr>
    <th colspan="2">Header</th>
  </tr>
  <tr>
    <td>Data 1</td>
    <td>Data 2</td>
  </tr>
</table>
"""

# Initialize parser with your HTML
parser = TableParser(html_content)

# Parse all tables in the HTML
tables = parser.parse()

if tables:
    table = tables[0]
    
    # Export to Markdown (perfect for LLM context windows)
    print(table.to_markdown())
    
    # Export to JSON
    # print(table.to_json())
    
    # Export to CSV
    # print(table.to_csv())

Command Line

The package installs a table2md command that reads from a file, a URL, or stdin:

# From a file
table2md page.html

# From a URL
table2md https://example.com/page.html

# From stdin (pipe or '-')
curl -s https://example.com/page.html | table2md
cat page.html | table2md - --format json

Options:

Option Description
--format, -f Output format: markdown (default), json, csv
--strategy, -s Rowspan fill strategy: fill_dito (default), repeat, empty
--dito-prefix Prefix used by the fill_dito strategy
--table, -t Extract only the table with this index (0-based)
--output, -o Write to a file instead of stdout; with CSV and multiple tables, writes name_1.csv, name_2.csv, …
--no-links / --no-bold / --no-italic Strip the respective inline formatting
--parser BeautifulSoup backend (lxml default, or html.parser)

Features

  • HTML parsing via BeautifulSoup
  • Recursive inline-tag formatting (keeps links, bold, and italic tags alive even if nested in divs)
  • Complex rowspan and colspan grid resolution (using flexible strategies like filling cells with "dito" to preserve context for LLMs)
  • Clean Markdown export
  • Data Exports: JSON and CSV serialization from the ParsedTable object
  • CLI: table2md command with file/URL/stdin input and Markdown/JSON/CSV output
  • AI Integrations: Includes a ready-to-use LangChain Document Loader
  • Robust against broken real-world HTML: invalid colspan/rowspan values, HTML comments, and oversized spans are handled gracefully

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License.

Blog-Posts:

** Read the 1. blog:** How to Stop LLMs from Hallucinating on Complex HTML Tables ** Read the 2. blog:** How to Stop LLMs from Hallucinating on Complex HTML Tables

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

html_table_rescuer-0.2.0.tar.gz (15.2 kB view details)

Uploaded Source

Built Distribution

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

html_table_rescuer-0.2.0-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

Details for the file html_table_rescuer-0.2.0.tar.gz.

File metadata

  • Download URL: html_table_rescuer-0.2.0.tar.gz
  • Upload date:
  • Size: 15.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for html_table_rescuer-0.2.0.tar.gz
Algorithm Hash digest
SHA256 5431f6c7fb060fbb90be801e327d178031a994f648dfe65a9eeda74c6d672572
MD5 9614b09840ba38e6d497ecc454d08ae5
BLAKE2b-256 ee27a66dfd93864c0b444669e3428c6298ccec37def5febafc0b6294121f2ff9

See more details on using hashes here.

Provenance

The following attestation bundles were made for html_table_rescuer-0.2.0.tar.gz:

Publisher: publish.yml on Encephos/table2md

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file html_table_rescuer-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for html_table_rescuer-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c196f4e8847ce2c06e7afe6a7d82d95b510e64e84ddeba11acd228217d07e8c6
MD5 4bb51a1278b59233d73f6c7fec5670af
BLAKE2b-256 ad1006bfd97ee5f8c9cd1dccb8ad9006457700bb79638c75e70b629807808e94

See more details on using hashes here.

Provenance

The following attestation bundles were made for html_table_rescuer-0.2.0-py3-none-any.whl:

Publisher: publish.yml on Encephos/table2md

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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