PyPDFForm


NamePyPDFForm JSON
Version 3.6.0 PyPI version JSON
download
home_pageNone
SummaryThe Python library for PDF forms.
upload_time2025-11-05 02:10:13
maintainerNone
docs_urlNone
authorJinge Li
requires_python>=3.10
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <p align="center"><img src="https://github.com/chinapandaman/PyPDFForm/raw/master/docs/img/logo.png"></p>
<p align="center">
    <em>PDF Form Automation Simplified – Create, Merge, Style, and Fill Forms Programmatically.</em>
</p>
<p align="center">
    <a href="https://pypi.org/project/PyPDFForm/"><img src="https://img.shields.io/pypi/v/pypdfform?label=version&color=magenta"></a>
    <a href="https://chinapandaman.github.io/PyPDFForm/"><img src="https://img.shields.io/github/v/release/chinapandaman/pypdfform?label=docs&color=cyan"></a>
    <a href="https://github.com/chinapandaman/PyPDFForm/actions/workflows/python-package.yml"><img src="https://img.shields.io/badge/coverage-100%25-green"></a>
    <a href="https://github.com/chinapandaman/PyPDFForm/raw/master/LICENSE"><img src="https://img.shields.io/github/license/chinapandaman/pypdfform?label=license&color=orange"></a>
    <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/pypi/pyversions/pypdfform?label=python&color=gold"></a>
    <a href="https://pepy.tech/projects/pypdfform"><img src="https://static.pepy.tech/badge/pypdfform/month"></a>
</p>

## Introduction

PyPDFForm is a free and open source pure-Python 3 library for PDF form processing. It contains the essential 
functionalities needed to interact with PDF forms:

* Inspect what data a PDF form needs to be filled with.
* Fill a PDF form by simply creating a Python dictionary.
* Create form fields on a PDF.

It also supports other common utilities such as extracting pages and merging multiple PDFs together.

## Installing

Install using [pip](https://pip.pypa.io/en/stable/):

```shell script
pip install PyPDFForm
```

## Quick Example
![Check out the GitHub repository for a live demo if you can't see it here.](https://github.com/chinapandaman/PyPDFForm/raw/master/docs/img/demo.gif)

A sample PDF form can be found [here](https://chinapandaman.github.io/PyPDFForm/pdfs/sample_template.pdf). Download it and try:

```python
from PyPDFForm import PdfWrapper

filled = PdfWrapper("sample_template.pdf", adobe_mode=True).fill(
    {
        "test": "test_1",
        "check": True,
        "test_2": "test_2",
        "check_2": False,
        "test_3": "test_3",
        "check_3": True,
    },
)

filled.write("output.pdf")
```

After running the above code snippet you can find `output.pdf` at the location you specified, 
and it should look like [this](https://chinapandaman.github.io/PyPDFForm/pdfs/sample_filled.pdf).

## Documentation

The official documentation can be found on [the GitHub page](https://chinapandaman.github.io/PyPDFForm/) of this repository.

## Other Resources

[Chicago Python User Group - Dec 14, 2023](https://youtu.be/8t1RdAKwr9w?si=TLgumBNXv9H8szSn)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "PyPDFForm",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": "Jinge Li",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/eb/ef/55c8f68bbf6b28d973b5cd53ee060b27671a95b8a579f0df82bbb1d9ea37/pypdfform-3.6.0.tar.gz",
    "platform": null,
    "description": "<p align=\"center\"><img src=\"https://github.com/chinapandaman/PyPDFForm/raw/master/docs/img/logo.png\"></p>\n<p align=\"center\">\n    <em>PDF Form Automation Simplified \u2013 Create, Merge, Style, and Fill Forms Programmatically.</em>\n</p>\n<p align=\"center\">\n    <a href=\"https://pypi.org/project/PyPDFForm/\"><img src=\"https://img.shields.io/pypi/v/pypdfform?label=version&color=magenta\"></a>\n    <a href=\"https://chinapandaman.github.io/PyPDFForm/\"><img src=\"https://img.shields.io/github/v/release/chinapandaman/pypdfform?label=docs&color=cyan\"></a>\n    <a href=\"https://github.com/chinapandaman/PyPDFForm/actions/workflows/python-package.yml\"><img src=\"https://img.shields.io/badge/coverage-100%25-green\"></a>\n    <a href=\"https://github.com/chinapandaman/PyPDFForm/raw/master/LICENSE\"><img src=\"https://img.shields.io/github/license/chinapandaman/pypdfform?label=license&color=orange\"></a>\n    <a href=\"https://www.python.org/downloads/\"><img src=\"https://img.shields.io/pypi/pyversions/pypdfform?label=python&color=gold\"></a>\n    <a href=\"https://pepy.tech/projects/pypdfform\"><img src=\"https://static.pepy.tech/badge/pypdfform/month\"></a>\n</p>\n\n## Introduction\n\nPyPDFForm is a free and open source pure-Python 3 library for PDF form processing. It contains the essential \nfunctionalities needed to interact with PDF forms:\n\n* Inspect what data a PDF form needs to be filled with.\n* Fill a PDF form by simply creating a Python dictionary.\n* Create form fields on a PDF.\n\nIt also supports other common utilities such as extracting pages and merging multiple PDFs together.\n\n## Installing\n\nInstall using [pip](https://pip.pypa.io/en/stable/):\n\n```shell script\npip install PyPDFForm\n```\n\n## Quick Example\n![Check out the GitHub repository for a live demo if you can't see it here.](https://github.com/chinapandaman/PyPDFForm/raw/master/docs/img/demo.gif)\n\nA sample PDF form can be found [here](https://chinapandaman.github.io/PyPDFForm/pdfs/sample_template.pdf). Download it and try:\n\n```python\nfrom PyPDFForm import PdfWrapper\n\nfilled = PdfWrapper(\"sample_template.pdf\", adobe_mode=True).fill(\n    {\n        \"test\": \"test_1\",\n        \"check\": True,\n        \"test_2\": \"test_2\",\n        \"check_2\": False,\n        \"test_3\": \"test_3\",\n        \"check_3\": True,\n    },\n)\n\nfilled.write(\"output.pdf\")\n```\n\nAfter running the above code snippet you can find `output.pdf` at the location you specified, \nand it should look like [this](https://chinapandaman.github.io/PyPDFForm/pdfs/sample_filled.pdf).\n\n## Documentation\n\nThe official documentation can be found on [the GitHub page](https://chinapandaman.github.io/PyPDFForm/) of this repository.\n\n## Other Resources\n\n[Chicago Python User Group - Dec 14, 2023](https://youtu.be/8t1RdAKwr9w?si=TLgumBNXv9H8szSn)\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "The Python library for PDF forms.",
    "version": "3.6.0",
    "project_urls": {
        "Documentation": "https://chinapandaman.github.io/PyPDFForm/",
        "Homepage": "https://github.com/chinapandaman/PyPDFForm"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "6bc8934dd97e73e07a1a9254d64d6824ba1610f849c39ff67b3f0b83ce9b0465",
                "md5": "c1976024d3bf68759f089d69cf95f577",
                "sha256": "61c01bf2c2e3eb104350ee7300cdb43568c67ce96166fba3395bcb0950289f0e"
            },
            "downloads": -1,
            "filename": "pypdfform-3.6.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c1976024d3bf68759f089d69cf95f577",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 118401,
            "upload_time": "2025-11-05T02:10:12",
            "upload_time_iso_8601": "2025-11-05T02:10:12.452836Z",
            "url": "https://files.pythonhosted.org/packages/6b/c8/934dd97e73e07a1a9254d64d6824ba1610f849c39ff67b3f0b83ce9b0465/pypdfform-3.6.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ebef55c8f68bbf6b28d973b5cd53ee060b27671a95b8a579f0df82bbb1d9ea37",
                "md5": "0ddea851cf8b38f17bf24ada7c970cd0",
                "sha256": "db6971eb5bbed6347932c628a4e44a13961639dc986e213c18bc9ee4136fa176"
            },
            "downloads": -1,
            "filename": "pypdfform-3.6.0.tar.gz",
            "has_sig": false,
            "md5_digest": "0ddea851cf8b38f17bf24ada7c970cd0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 116182,
            "upload_time": "2025-11-05T02:10:13",
            "upload_time_iso_8601": "2025-11-05T02:10:13.933916Z",
            "url": "https://files.pythonhosted.org/packages/eb/ef/55c8f68bbf6b28d973b5cd53ee060b27671a95b8a579f0df82bbb1d9ea37/pypdfform-3.6.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-11-05 02:10:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "chinapandaman",
    "github_project": "PyPDFForm",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pypdfform"
}
        
Elapsed time: 4.28314s