semvec/pypi-packages huggingface dataset:
docx-footer-metadata-extractor 1.0.0
A Python library for extracting metadata from DOCX file footers using parallel processing
License: MIT
Requires Python: >=3.9
Keywords: docx, metadata, footer, parallel, extraction, office, documents

# DOCX Footer Metadata Extractor

A Python library for extracting metadata from DOCX file footers using parallel processing.

## Features

- Extract key-value pairs from DOCX file footers
- Process multiple files in parallel for better performance
- Support for both folder processing and specific file lists
- Extract metadata from footer text and tables
- Python 3.9+ compatibility
- Thread-safe processing with error handling

## Installation

```bash
pip install docx-footer-metadata-extractor
```

## Quick Start

```python
pythonfrom docx_footer_metadata_extractor import DocxFooterMetadataExtractor

# Create extractor instance
extractor = DocxFooterMetadataExtractor(max_workers=4)

# Process all DOCX files in a folder
results = extractor.extract_metadata("./documents")

# Process specific files
file_list = ["doc1.docx", "doc2.docx", "folder/doc3.docx"]
results = extractor.extract_metadata(file_list)

# Results format
for result in results:
    filename = result['filename']
    metadata = result['metadata']
    print(f"{filename}: {metadata}")
```

## Usage

### Using the Class

```python
from docx_footer_metadata_extractor import DocxFooterMetadataExtractor

extractor = DocxFooterMetadataExtractor(max_workers=4)

# Process folder
results = extractor.extract_metadata("./my_documents")

# Process specific files
results = extractor.extract_metadata([
    "document1.docx",
    "path/to/document2.docx"
])

# Save results to file
extractor.save_results_to_file(results, "output.txt")
```

### Using the Convenience Function

```python
from docx_footer_metadata_extractor import extract_footer_metadata

# Quick extraction
results = extract_footer_metadata("./documents", max_workers=2, verbose=False)
```

### Output Format

The library returns a list of dictionaries with the following structure:

```bash
python[
    {
        "filename": "document1.docx",
        "metadata": {
            "Author": "John Doe",
            "Version": "1.0",
            "Date": "2025-01-15"
        }
    },
    {
        "filename": "document2.docx",
        "metadata": {
            "Title": "Report",
            "Department": "Sales"
        }
    }
]
```

### Requirements

Python 3.9+
python-docx>=0.8.11