Skip to main content

A library to convert PDF files to Markdown format.

Project description

PDF2Markdown4LLM

PDF2Markdown4LLM is a Python library that converts PDF documents to Markdown format, specifically optimized for Large Language Models (LLMs). It intelligently preserves document structure, identifies headers based on font sizes, and handles tables while maintaining the original document flow.

Features

  • Intelligent header detection based on font size analysis
  • Table extraction and conversion to Markdown format
  • Maintains document structure and flow
  • Handles nested content and complex layouts
  • Font size classification for consistent header levels
  • Clean table formatting with proper alignment
  • Optional header removal functionality
  • Robust error handling and validation

Installation

pip install pdf2markdown4llm

Dependencies

  • pdfplumber
  • dataclasses (Python 3.7+)
  • typing
  • collections
  • re

Usage

Basic usage example:

from pdf2markdown4llm import PDF2Markdown4LLM

def progress_callback(progress): 
    """Callback function to handle progress"""
    print(f"Phase: {progress.phase.value}, Page {progress.current_page}/{progress.total_pages}, Progress: {progress.percentage:.1f}%, Message: {progress.message}")


# Initialize converter
converter = PDF2Markdown4LLM(remove_headers=False, skip_empty_tables=True, table_header="### Table", progress_callback=progress_callback)


# Convert PDF to Markdown
markdown_content = converter.convert("input.pdf")

# Save to file
with open("output.md", "w", encoding="utf-8") as md_file:
    md_file.write(markdown_content)

Configuration Options

  • remove_headers: Boolean flag to remove existing markdown headers from text (default: False)
  • table_header: String to specify the header level for tables (default: "###")

Key Components

FontSizeClassifier

Analyzes font sizes throughout the document to determine appropriate header levels:

  • Automatically identifies the normal text size
  • Classifies larger fonts into appropriate header levels
  • Handles font size variations and inconsistencies

PDFContentExtractor

Extracts content while preserving structure:

  • Processes text and tables separately
  • Maintains original document flow
  • Validates table boundaries
  • Handles nested content

MarkdownConverter

Converts extracted content to clean Markdown:

  • Proper table formatting
  • Header level preservation
  • Clean text formatting

Error Handling

The library includes comprehensive error handling:

  • Validates table boundaries
  • Checks for invalid content
  • Provides detailed error messages
  • Includes stack traces for debugging

Contributing

Contributions are welcome! Please feel free to submit pull requests.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/new-feature)
  3. Commit your changes (git commit -am 'Add new feature')
  4. Push to the branch (git push origin feature/new-feature)
  5. Create a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Author

[HawkClaws]

Acknowledgements

  • PDFPlumber team for the excellent PDF parsing library
  • Contributors and maintainers

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

pdf2markdown4llm-0.1.4.tar.gz (10.1 kB view details)

Uploaded Source

Built Distribution

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

pdf2markdown4llm-0.1.4-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pdf2markdown4llm-0.1.4.tar.gz
  • Upload date:
  • Size: 10.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for pdf2markdown4llm-0.1.4.tar.gz
Algorithm Hash digest
SHA256 413797b046600500f2d1dbe52633202da8a8a66893685d911a9390caab07725d
MD5 8b0cf10576b685dee52747b297ff6929
BLAKE2b-256 4a7edd7575792c67a2ebd2c015fb62203c178a225aa40ae82b0380c4d317f0df

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pdf2markdown4llm-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b49dd681e04c4b05a1760122f6b28bd022ad4b53387b5b5722e12d34d06e4cb2
MD5 4c67bacaa5d709af4d241fddde89c128
BLAKE2b-256 084febcad1074a9d42d65457ca3423ca2bc675d8b449a8ec743ed149e48adffd

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