A Library to fill and flatten pdfs
Project description
fillpdf
https://pypi.org/project/fillpdf/
Overview
This is a simple package to make filling pdfs much easier. I have delt with a lot projects that involve manipulating pdfs in python. I found no easy solution for writting, or flattening pdfs, so I decided to make a library to make this task much easier. As a young software engineer I kept this library really simple but practicle and am open to any input for the future!
- Fills pdfs
- Lists fields in pdf
- Flattens pdfs (Turns to a non-editable pdf)
Function Documentation
import fillpdf
from fillpdf import fillpdfs
get_form_fields (returns the data_dict)
get_form_fields(input_pdf_path)
- input_pdf_path- path to your pdf you want to alter (including the pdf name could just leave as 'blank.pdf' if the pdf is in your current directory)
For Example:
fillpdfs.get_form_fields('blank.pdf')
print_form_fields (prints the data_dict)
print_form_fields(input_pdf_path)
- input_pdf_path- path to your pdf you want to alter (including the pdf name could just leave as 'blank.pdf' if the pdf is in your current directory)
For Example:
fillpdfs.print_form_fields('blank.pdf')
write_fillable_pdf
write_fillable_pdf(input_pdf_path, output_pdf_path, data_dict, flatten=False)
- input_pdf_path- path to your pdf you want to alter (including the pdf name could just leave as 'blank.pdf' if the pdf is in your current directory)
- output_pdf_path- path of where you want your pdf to write to (including the pdf name could just leave as 'new.pdf' to write to current directory)
- data_dict- dictionary that contains the fields to write to as your key and what to write to it as your value (get this from the get_form_fields function)
- flatten (default=False)- If True, then the fields will become uneditable when you write to the pdf.
For Example:
data_dict = {'Address 1 Text Box': '500 West Main Street',
'Driving License Check Box': 'Yes',
'Language 1 Check Box': 'Off',}
fillpdfs.write_fillable_pdf('blank.pdf', 'new.pdf', data_dict)
- For radio boxes ('Off' = not filled, 'Yes' = filled)
flatten_pdf
flatten_pdf(input_pdf_path, output_pdf_path, as_images=False)
- input_pdf_path- path to your pdf you want to alter (including the pdf name could just leave as 'blank.pdf' if the pdf is in your current directory)
- output_pdf_path- path of where you want your pdf to write to (including the pdf name could just leave as 'new.pdf' to write to current directory)
- as_images=False- Default is False meaning it will update each individual annotation and set it to False. True means it will convert to images and then reinsert into the pdf. Try this if the first is not working. (this image technique requires poppler.)
For Example:
fillpdfs.flatten_pdf('new.pdf', 'newflat.pdf')
Installation
pip install fillpdf
conda install -c conda-forge poppler
Development Environment
Builds upon
- 'pdfrw'
- 'pdf2image'
- 'Pillow'
- 'poppler'
Useful Websites
Credit
Future Work
- Add perfect fill (sometimes does not fill random things ie. drop down lists)
- give option to place text by coordinate
- easier way to fill the data dictionary in write_fillable_pdf function
- fill drop downs
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
fillpdf-0.4.0.tar.gz
(10.2 kB
view details)
Built Distribution
fillpdf-0.4.0-py3-none-any.whl
(11.1 kB
view details)
File details
Details for the file fillpdf-0.4.0.tar.gz
.
File metadata
- Download URL: fillpdf-0.4.0.tar.gz
- Upload date:
- Size: 10.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.5.0.1 requests/2.26.0 setuptools/49.2.0.post20200714 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d531073808f9905ff3264f1f348f09dc9e1509eaf6695b07e4c8535b1c1685ce |
|
MD5 | 3af967703c7440fa9688d16f3138c9b2 |
|
BLAKE2b-256 | 2a70a7a83694d1241e8f5fb0a611577cb729f485051d9b597d061408b0fb34ee |
File details
Details for the file fillpdf-0.4.0-py3-none-any.whl
.
File metadata
- Download URL: fillpdf-0.4.0-py3-none-any.whl
- Upload date:
- Size: 11.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.5.0.1 requests/2.26.0 setuptools/49.2.0.post20200714 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | db44fcb14caef55aa30bfa0b2aa700cfaad496e3bdf445489d6cccc36c6f034f |
|
MD5 | b4c9330b2b5c67d04864cb798fad4887 |
|
BLAKE2b-256 | 7277feabac1f34f083a2fc8ad7a62ad2612c077a54fdd35dd6dfe8f5ac037367 |