Skip to content

Document

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

8 modules

ModuleDescription
Leer ExcelLeer datos de archivos Excel (xlsx, xls)
Escribir ExcelEscribir datos a archivos Excel (xlsx)
Llenar formulario PDFLlenar campos de formulario PDF con datos e insertar imagenes opcionalmente
Generar PDFGenerar archivos PDF desde contenido HTML o texto
Parsear PDFExtraer texto y metadatos de archivos PDF
PDF a WordConvertir archivos PDF a documentos Word (.docx)
Parsear documento WordExtraer texto y contenido de documentos Word (.docx)
Word a PDFConvertir documentos Word (.docx) a archivos PDF

Modules

Leer Excel

excel.read

Leer datos de archivos 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
dataarrayFilas de datos extraidas
headersarrayFilas de datos extraidas
row_countnumberFilas de datos extraidas
sheet_namesarrayEncabezados de columna

Example: Read entire sheet

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

Escribir Excel

excel.write

Escribir datos a archivos 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
pathstringRuta al archivo Excel creado
row_countnumberRuta al archivo Excel creado
sizenumberRuta al archivo Excel creado

Example: Write data to Excel

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

Llenar formulario PDF

pdf.fill_form

Llenar campos de formulario PDF con datos e insertar imagenes opcionalmente

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_pathstringRuta al PDF llenado
fields_fillednumberRuta al PDF llenado
images_insertednumberRuta al PDF llenado
file_size_bytesnumberNumero de imagenes insertadas

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

Generar PDF

pdf.generate

Generar archivos PDF desde contenido HTML o texto

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_pathstringRuta al PDF generado
page_countnumberRuta al PDF generado
file_size_bytesnumberNumero de paginas en el PDF

Example: Generate from HTML

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

Parsear PDF

pdf.parse

Extraer texto y metadatos de archivos 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
textstringContenido de texto extraido
pagesarrayContenido de texto extraido
metadataobjectContenido de texto extraido
page_countnumberContenido de texto por pagina

Example: Extract all text from PDF

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

PDF a Word

pdf.to_word

Convertir archivos PDF a documentos 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_pathstringRuta al documento Word generado
page_countnumberRuta al documento Word generado
file_sizenumberNumero de paginas convertidas

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

Parsear documento Word

word.parse

Extraer texto y contenido de documentos 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
textstringContenido de texto completo del documento
paragraphsarrayContenido de texto completo del documento
tablesarrayContenido de texto completo del documento
imagesarrayLista de parrafos
metadataobjectTablas extraidas como 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 a PDF

word.to_pdf

Convertir documentos Word (.docx) a archivos 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_pathstringRuta al archivo PDF generado
file_sizenumberNumero de paginas convertidas
method_usedstringTamano del archivo de salida en 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.