Skip to content

Document

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

8 modules

ModuleDescription
Odczytaj ExcelOdczytaj dane z plikow Excel (xlsx, xls)
Zapisz ExcelZapisz dane do plikow Excel (xlsx)
Wypelnij formularz PDFWypelnij pola formularza PDF danymi i opcjonalnie wstaw obrazy
Generuj PDFGeneruj pliki PDF z zawartosci HTML lub tekstu
Parsuj PDFWyodrebnij tekst i metadane z plikow PDF
PDF do WordKonwertuj pliki PDF na dokumenty Word (.docx)
Parsuj dokument WordWyodrębnij tekst i zawartość z dokumentów Word (.docx)
Word do PDFKonwertuj dokumenty Word (.docx) na pliki PDF

Modules

Odczytaj Excel

excel.read

Odczytaj dane z plikow Excel (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
dataarrayWyodrebnione wiersze danych
headersarrayWyodrebnione wiersze danych
row_countnumberWyodrebnione wiersze danych
sheet_namesarrayNaglowki kolumn

Example: Read entire sheet

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

Zapisz Excel

excel.write

Zapisz dane do plikow Excel (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
pathstringSciezka do utworzonego pliku Excel
row_countnumberSciezka do utworzonego pliku Excel
sizenumberSciezka do utworzonego pliku Excel

Example: Write data to Excel

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

Wypelnij formularz PDF

pdf.fill_form

Wypelnij pola formularza PDF danymi i opcjonalnie wstaw obrazy

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_pathstringSciezka do wypelnionego PDF
fields_fillednumberSciezka do wypelnionego PDF
images_insertednumberSciezka do wypelnionego PDF
file_size_bytesnumberLiczba wstawionych obrazow

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}]

Generuj PDF

pdf.generate

Generuj pliki PDF z zawartosci HTML lub tekstu

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_pathstringSciezka do wygenerowanego PDF
page_countnumberSciezka do wygenerowanego PDF
file_size_bytesnumberLiczba stron w PDF

Example: Generate from HTML

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

Parsuj PDF

pdf.parse

Wyodrebnij tekst i metadane z plikow PDF

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
textstringWyodrebniona zawartosc tekstowa
pagesarrayWyodrebniona zawartosc tekstowa
metadataobjectWyodrebniona zawartosc tekstowa
page_countnumberZawartosc tekstowa na strone

Example: Extract all text from PDF

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

PDF do Word

pdf.to_word

Konwertuj pliki PDF na dokumenty Word (.docx)

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_pathstringSciezka do wygenerowanego dokumentu Word
page_countnumberSciezka do wygenerowanego dokumentu Word
file_sizenumberLiczba skonwertowanych stron

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

Parsuj dokument Word

word.parse

Wyodrębnij tekst i zawartość z dokumentów Word (.docx)

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
textstringPełna zawartość tekstowa dokumentu
paragraphsarrayPełna zawartość tekstowa dokumentu
tablesarrayPełna zawartość tekstowa dokumentu
imagesarrayLista akapitów
metadataobjectWyodrębnione tabele jako tablice

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 do PDF

word.to_pdf

Konwertuj dokumenty Word (.docx) na pliki PDF

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_pathstringŚcieżka do wygenerowanego pliku PDF
file_sizenumberŚcieżka do wygenerowanego pliku PDF
method_usedstringRozmiar pliku wyjściowego w bajtach

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.