pdf-parser-header-footer 0.2.0

A Python package for processing PDFs with header and footer detection

PDF Parser with Header and Footer

A Python package for automatically detecting and extracting headers, body text, and footers from PDF documents. The package supports spanish language and provides both visual boundary detection and structured text extraction with advanced processing capabilities including markdown conversion.

Features

• 📄 Automatic detection of headers, footers, and body sections in PDF documents
• 🌍 Spanish language support
• 🎯 Precise boundary detection for consistent text extraction
• 📊 JSON output with structured content
• 👁️ Visual PDF output showing detected boundaries
• 📁 Process single files or entire directories
• ⚙️ Flexible configuration options
• 📝 Markdown conversion with intelligent formatting
• 📚 ML-based title and text structure detection
• 🔄 Smart line joining for improved readability

Installation

pip install pdf-parser-header-footer

Quick Start

from pdf_parser_header_footer import PDFSectionParser, ParserConfig
from pathlib import Path
# Use default settings (generate both PDF and JSON)
parser = PDFSectionParser()
parser.parse("path/to/document.pdf")

# Custom configuration
config = ParserConfig(
    generate_boundaries_pdf=True,
    generate_json=True,
    parse_to_markdown=True,  # Enable markdown conversion
    output_dir=Path("custom/output/dir")
)
parser = PDFSectionParser(config)
parser.parse("path/to/pdf/directory")

Configuration Options

Parameter	Default	Description
generate_boundaries_pdf	True	Generate PDF with visual boundary markers
generate_json	True	Generate JSON output with structured content
parse_to_markdown	True	Convert extracted text to markdown format
output_dir	None	Custom output directory (default: same as input)

Output Format

JSON Output

{
    "pdf_with_lines": "document_final_boundaries.pdf",
    "pages": [
        {
            "number": 1,
            "header": "Header text...",
            "body": "Main content...",
            "footer": "Footer text..."
        }
    ]
}

Visual PDF Output

The package generates a PDF file with colored lines showing detected boundaries:

• 🔵 Blue lines: Header boundaries
• 🟢 Green lines: Bottom footer boundaries
• 🔴 Red lines: Right footer boundaries

Advanced Features

Markdown Conversion

The parse_to_markdown option enables intelligent conversion of PDF text to markdown format:

• Automatic detection and formatting of titles and headings
• Proper handling of bullet points and numbered lists
• Table structure preservation
• Smart line joining for paragraphs
• Figure and image reference formatting

Machine Learning Components

The package uses ML classifiers to improve text processing:

• Title Classifier: Detects and properly formats section titles and headings
• Line Joiner Classifier: Intelligently determines when lines should be joined into paragraphs

Requirements

• Python 3.8 or higher
• PyMuPDF (1.25.4 or higher)
• PyMuPDF4LLM (0.0.18 or higher)
• tqdm

Examples

Process Single File with Basic Settings

from pdf_parser_header_footer import PDFSectionParser

parser = PDFSectionParser()
parser.parse("document.pdf")

Process Directory with Advanced Features

from pdf_parser_header_footer import PDFSectionParser, ParserConfig
from pathlib import Path

config = ParserConfig(
    generate_boundaries_pdf=True,
    generate_json=True,            
    parse_to_markdown=True,        # Enable conversion to markdown
    output_dir=Path("output_dir")  # Custom output directory
)

parser = PDFSectionParser(config)
parser.parse("path/to/pdf/directory")

Disable Specific Features

from pdf_parser_header_footer import PDFSectionParser, ParserConfig

config = ParserConfig(
    generate_boundaries_pdf=False,  # Skip boundary PDF generation
    generate_json=True,             # Generate JSON output
    parse_to_markdown=True,         # Enable markdown conversion
)

parser = PDFSectionParser(config)
parser.parse("document.pdf")

Processing Pipeline

The package follows this processing sequence:

1. Detect header and footer boundaries in the PDF
2. Split the document into header, body, and footer sections
3. Generate visualizations of detected boundaries
4. Extract text from each section
5. Convert extracted text to markdown (if enabled)
6. Generate structured JSON output

Contributing

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

License

This project is licensed under the GNU Affero General Public License v3 (AGPL-3.0).

This program incorporates work covered by the following copyright and permission notices:

PyMuPDF (https://github.com/pymupdf/PyMuPDF) Copyright (c) 2016-2024 Artifex Software, Inc. Licensed under GNU Affero General Public License version 3

Contact

Tamara Orlich - [[e-mail]]

Project Link: [https://github.com/BorahLabs/pdf_parser_with_header_footer/]