Skip to content

Document

Excel, PDF, and Word document read/write/convert.

8 modules

ModuleDescription
Excel lesenDaten aus Excel-Dateien lesen (xlsx, xls)
Excel schreibenDaten in Excel-Dateien schreiben (xlsx)
PDF-Formular ausfüllenPDF-Formularfelder mit Daten füllen und optional Bilder einfügen
PDF generierenPDF-Dateien aus HTML-Inhalt oder Text generieren
PDF parsenText und Metadaten aus PDF-Dateien extrahieren
PDF zu WordPDF-Dateien in Word-Dokumente (.docx) konvertieren
Word-Dokument parsenText und Inhalt aus Word-Dokumenten (.docx) extrahieren
Word zu PDFWord-Dokumente (.docx) in PDF-Dateien konvertieren

Modules

Excel lesen

excel.read

Daten aus Excel-Dateien lesen (xlsx, xls)

Parameters:

NameTypeRequiredDefaultDescription
pathstringYes-Path to the Excel file
sheetstringNo-Sheet name (default: first sheet)
header_rownumberNo1Row number for headers (1-based, 0 for no headers)
rangestringNo-Cell range to read (e.g., "A1:D10")
as_dictbooleanNoTrueReturn rows as dictionaries (using headers as keys)

Output:

FieldTypeDescription
dataarrayExtrahierte Datenzeilen
headersarrayExtrahierte Datenzeilen
row_countnumberExtrahierte Datenzeilen
sheet_namesarraySpaltenüberschriften

Example: Read entire sheet

yaml
path: /tmp/data.xlsx
as_dict: true

Excel schreiben

excel.write

Daten in Excel-Dateien schreiben (xlsx)

Parameters:

NameTypeRequiredDefaultDescription
pathstringYes-Path to the Excel file
dataarrayYes-Data to write (array of arrays or array of objects)
headersarrayNo-Column headers (auto-detected from objects if not provided)
sheet_namestringNoSheet1Name of the worksheet
auto_widthbooleanNoTrueAutomatically adjust column widths

Output:

FieldTypeDescription
pathstringPfad zur erstellten Excel-Datei
row_countnumberPfad zur erstellten Excel-Datei
sizenumberPfad zur erstellten Excel-Datei

Example: Write data to Excel

yaml
path: /tmp/output.xlsx
data: [{"name": "Alice", "age": 30}, {"name": "Bob", "age": 25}]

PDF-Formular ausfüllen

pdf.fill_form

PDF-Formularfelder mit Daten füllen und optional Bilder einfügen

Parameters:

NameTypeRequiredDefaultDescription
templatestringYes-Path to the PDF template file
outputstringYes-Path for the output document
fieldsobjectNo{}Key-value pairs of form field names and values
imagesarrayNo[]List of images to insert with position info
flattenbooleanNoTrueFlatten form fields (make them non-editable)

Output:

FieldTypeDescription
output_pathstringPfad zur ausgefüllten PDF
fields_fillednumberPfad zur ausgefüllten PDF
images_insertednumberPfad zur ausgefüllten PDF
file_size_bytesnumberAnzahl der eingefügten Bilder

Example: Fill form with text fields

yaml
template: /templates/form.pdf
output: /output/filled.pdf
fields: {"name": "John Doe", "id_number": "A123456789", "date": "2024-01-01"}

Example: Fill form with photo

yaml
template: /templates/id_card.pdf
output: /output/id_card_filled.pdf
fields: {"name": "Jane Doe"}
images: [{"file": "/photos/jane.jpg", "page": 1, "x": 50, "y": 650, "width": 100, "height": 120}]

PDF generieren

pdf.generate

PDF-Dateien aus HTML-Inhalt oder Text generieren

Parameters:

NameTypeRequiredDefaultDescription
contentstringYes-HTML or text content to convert to PDF
output_pathstringYes-Path for the output document
titlestringNo-Document title (metadata)
authorstringNo-Document author (metadata)
page_sizeselect (A4, Letter, Legal, A3, A5)NoA4Page size format
orientationselect (portrait, landscape)NoportraitPage orientation
marginnumberNo20Page margin in millimeters
headerstringNo-Header text for each page
footerstringNo-Footer text for each page

Output:

FieldTypeDescription
output_pathstringPfad zur generierten PDF
page_countnumberPfad zur generierten PDF
file_size_bytesnumberAnzahl der Seiten in der PDF

Example: Generate from HTML

yaml
content: <h1>Report</h1><p>Content here</p>
output_path: /path/to/report.pdf
title: Monthly Report

PDF parsen

pdf.parse

Text und Metadaten aus PDF-Dateien extrahieren

Parameters:

NameTypeRequiredDefaultDescription
pathstringYes-Path to the PDF file
pagesstringNoallPage range (e.g., "1-5", "1,3,5", or "all")
extract_imagesbooleanNoFalseExtract embedded images
extract_tablesbooleanNoFalseExtract tables as structured data

Output:

FieldTypeDescription
textstringExtrahierter Textinhalt
pagesarrayExtrahierter Textinhalt
metadataobjectExtrahierter Textinhalt
page_countnumberTextinhalt pro Seite

Example: Extract all text from PDF

yaml
path: /tmp/document.pdf
pages: all

PDF zu Word

pdf.to_word

PDF-Dateien in Word-Dokumente (.docx) konvertieren

Parameters:

NameTypeRequiredDefaultDescription
input_pathstringYes-Path to the input document
output_pathstringNo-Path for the output document
preserve_formattingbooleanNoTruePreserve basic formatting
pagesstringNoallPage range (e.g., "1-5", "1,3,5", or "all")

Output:

FieldTypeDescription
output_pathstringPfad zum generierten Word-Dokument
page_countnumberPfad zum generierten Word-Dokument
file_sizenumberAnzahl der konvertierten Seiten

Example: Convert entire PDF to Word

yaml
input_path: /tmp/document.pdf

Example: Convert specific pages

yaml
input_path: /tmp/document.pdf
output_path: /tmp/output.docx
pages: 1-5

Word-Dokument parsen

word.parse

Text und Inhalt aus Word-Dokumenten (.docx) extrahieren

Parameters:

NameTypeRequiredDefaultDescription
file_pathstringYes-Path to the Word document (.docx)
extract_tablesbooleanNoTrueExtract tables as structured data
extract_imagesbooleanNoFalseExtract embedded images
images_output_dirstringNo-Directory to save extracted images
preserve_formattingbooleanNoFalsePreserve basic formatting

Output:

FieldTypeDescription
textstringVollständiger Textinhalt des Dokuments
paragraphsarrayVollständiger Textinhalt des Dokuments
tablesarrayVollständiger Textinhalt des Dokuments
imagesarrayListe der Absätze
metadataobjectExtrahierte Tabellen als Arrays

Example: Extract text from Word

yaml
file_path: /path/to/document.docx

Example: Extract with tables and images

yaml
file_path: /path/to/document.docx
extract_tables: true
extract_images: true
images_output_dir: /path/to/images/

Word zu PDF

word.to_pdf

Word-Dokumente (.docx) in PDF-Dateien konvertieren

Parameters:

NameTypeRequiredDefaultDescription
input_pathstringYes-Path to the input document
output_pathstringNo-Path for the output document
methodselect (auto, libreoffice, docx2pdf)NoautoMethod to use for conversion

Output:

FieldTypeDescription
output_pathstringPfad zur generierten PDF-Datei
file_sizenumberPfad zur generierten PDF-Datei
method_usedstringGröße der Ausgabedatei in Bytes

Example: Convert Word to PDF

yaml
input_path: /tmp/document.docx

Example: Convert with specific output path

yaml
input_path: /tmp/document.docx
output_path: /tmp/output.pdf

Released under the Apache 2.0 License.