Python API

PDF

class RPA.PDF.PDF

Bases: robotlibcore.DynamicCore

PDF is a library for managing PDF documents.

It can be used to extract text from PDFs, add watermarks to pages, and decrypt/encrypt documents.

There is also limited support for updating form field values.

Input PDF file can be passed as an argument to the keywords, or it can be omitted if you first call Open PDF. Reference to the current active PDF will be stored in the library instance.

Examples

Robot Framework

***Settings***
Library    RPA.PDF

***Tasks***
Extract Data
    ${text}=    Get Text From PDF    ./tmp/sample.pdf

Fill Form
    Open PDF    ./tmp/sample.pdf
    Set Field Value    phone_nr   080123123
    Set Field Value    address    robot street 14
    Save Field Values  output_path=output.pdf

from RPA.PDF import PDF

pdf = PDF()

def extract_data():
    text = pdf.get_text_from_pdf("./tmp/sample.pdf")

def fill_form():
    pdf.open_pdf("./tmp/sample.pdf")
    pdf.set_field_value("phone_nr", 080123123)
    pdf.set_field_value("address", "robot street 14")
    pdf.save_field_values(output_path="output.pdf")

ROBOT_LIBRARY_DOC_FORMAT = 'REST'

ROBOT_LIBRARY_SCOPE = 'GLOBAL'

add_library_components(library_components)

get_keyword_arguments(name)

get_keyword_documentation(name)

get_keyword_names()

get_keyword_source(keyword_name)

get_keyword_tags(name)

get_keyword_types(name)

run_keyword(name, args, kwargs=None)