Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

pdfformfields is a Python wrapper around pdftk that fills in pdf forms from a Python dictionary.

Project description


pdfformfields is a Python wrapper around pdftk that lets the user fill in forms from a Python dictionary.


You need to have pdftk server on your computer installed.


To install, simply run

pip install pdfformfields


from pdfformfields import fill_form_fields, generate_dictionary

# Example pdf containing two fields with ids: first_name, last_name
example_input_pdf = "example_input.pdf"

# Use generate_dictionary() with verbose=True to understand the structure
# generate_dictionary(example_input_pdf, verbose=True)

# Use generate_dictionary() without verbose=True to generate a copiable code for the field dictionary onto the console

""" The output should be:
rename_me = {
    "first_name": ,
    "last_name": ,

# Paste code, rename dictionary, and fill in the values however you like
form_field_dictionary = {
    "first_name": "John",
    "last_name": "Doe",

# Output filled in dictionary with the fill_form_fields() function
example_output_pdf = r"example_output.pdf"
fill_form_fields(example_input_pdf, form_field_dictionary, example_output_pdf)

# If you don't want the output to be editable set flatten=True
example_output_pdf_flattened = r"example_output_pdf_flattened.pdf"
fill_form_fields(example_input_pdf, form_field_dictionary, example_output_pdf_flattened, flatten=True)

See complete example.

Bash error

The package did not manage to locate your pdftk command.

Make sure that pdftk server is installed on your system. If it is, try setting the pdftk argument of fill_form_fields to ...

... on Linux:

fill_form_fields(..., pdftk_command="pdftk")

... on Windows:

pdftk_path = os.path.join("path_to_pdftk_server_folder", "bin", "pdftk.exe")
fill_form_fields(..., pdftk_command=pdftk_path)

Built With


  • Nguyen Ba Long


This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details


  • pypdftk Inspiration: another wrapper around pdftk that does not work under Windows and Python 3.7, which is why this package was created.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pdfformfields, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size pdfformfields-0.0.3-py3-none-any.whl (17.4 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size pdfformfields-0.0.3.tar.gz (4.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page