PyPDFForm
PyPDFForm is a pure-python library for PDF form processing. It allows filling a PDF form programmatically by creating a python dictionary with keys matching its annotation names for elements like text fields and checkboxes. It also supports other functionalities such as drawing image and merging multiple PDFs together.
Installing
Install using pip:
pip install PyPDFForm
Quick Example
A sample PDF form can be found here. Download it and try:
import os
from PyPDFForm import PyPDFForm
PATH_TO_DOWNLOADED_SAMPLE_PDF_FORM = os.path.join(
os.path.expanduser("~/Downloads"), "sample_template.pdf"
) # Change this to where you downloaded the sample PDF form
PATH_TO_FILLED_PDF_FORM = os.path.join(
os.path.expanduser("~"), "output.pdf"
) # Change this to where you wish to put your filled PDF form
with open(PATH_TO_DOWNLOADED_SAMPLE_PDF_FORM, "rb+") as template:
filled_pdf = PyPDFForm(template.read(), simple_mode=False).fill(
{
"test": "test_1",
"check": True,
"test_2": "test_2",
"check_2": False,
"test_3": "test_3",
"check_3": True,
},
font_size=20,
)
with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
output.write(filled_pdf.stream)
After running the above code snippet you can find output.pdf at the location you specified
and it should look like this.
Documentation
- API Reference: https://github.com/chinapandaman/PyPDFForm/blob/master/docs/api_reference.md
- Examples: https://github.com/chinapandaman/PyPDFForm/blob/master/docs/examples.md
Tests
PyPDFForm utilizes pytest for unit and functional tests. Tests can be run by first installing dependencies using pip:
pip install -r requirements.txt
Alternatively, there is a bash script which will setup a python virtual environment and install all needed dependencies if you are running Linux:
./scripts/build.sh
In order to run tests, source root needs to be added to PYTHONPATH by running the following command at project root:
export PYTHONPATH=$PYTHONPATH:$(pwd)/PyPDFForm
From there run tests using:
pytest -v
Or you can use this bash script to do the above two steps if you are running Linux:
./scripts/test.sh
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file PyPDFForm-0.1.1.tar.gz.
File metadata
- Download URL: PyPDFForm-0.1.1.tar.gz
- Upload date:
- Size: 6.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3f5d839d6d8faf1913a78d5e8dee1369c4bdaed1a13811fa02999f5afb81bfdc
|
|
| MD5 |
3587eff05cfbf94f913553c14bc092cc
|
|
| BLAKE2b-256 |
3dc0dcd10ee9021b3af86b464c720f3af1c4e05ed0c5b9e198975d8f0ed2cb41
|
File details
Details for the file PyPDFForm-0.1.1-py3-none-any.whl.
File metadata
- Download URL: PyPDFForm-0.1.1-py3-none-any.whl
- Upload date:
- Size: 7.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
844d8c394fc0ac9c0b28bfdc2ed25989d186bd1a7a8f1364ca1a4d8ea16a8562
|
|
| MD5 |
f2277f113b5117955fe96e72c1f9123c
|
|
| BLAKE2b-256 |
dacf577ea95b232d9a6f86004752b23c14a8ff957e5be6ebb78c0bfdb977f719
|
