PyPDFForm


NamePyPDFForm JSON
Version 3.1.3 PyPI version JSON
download
home_pageNone
SummaryThe Python library for PDF forms.
upload_time2025-07-12 01:21:05
maintainerNone
docs_urlNone
authorJinge Li
requires_python>=3.9
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">
    <a href="https://pypi.org/project/PyPDFForm/"><img src="https://img.shields.io/pypi/v/pypdfform?logo=pypi&logoColor=white&label=version&labelColor=black&color=magenta&style=for-the-badge"></a>
    <a href="https://chinapandaman.github.io/PyPDFForm/"><img src="https://img.shields.io/github/v/release/chinapandaman/pypdfform?logo=read%20the%20docs&logoColor=white&label=docs&labelColor=black&color=cyan&style=for-the-badge"></a>
    <a href="https://github.com/chinapandaman/PyPDFForm/actions/workflows/python-package.yml"><img src="https://img.shields.io/badge/coverage-100%25-green?logo=codecov&logoColor=white&labelColor=black&style=for-the-badge"></a>
    <a href="https://github.com/chinapandaman/PyPDFForm/raw/master/LICENSE"><img src="https://img.shields.io/github/license/chinapandaman/pypdfform?logo=github&logoColor=white&label=license&labelColor=black&color=orange&style=for-the-badge"></a>
    <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/pypi/pyversions/pypdfform?logo=python&logoColor=white&label=python&labelColor=black&color=gold&style=for-the-badge"></a>
    <a href="https://pypistats.org/packages/pypdfform"><img src="https://img.shields.io/pypi/dm/pypdfform?logo=pypi&logoColor=white&label=downloads&labelColor=black&color=blue&style=for-the-badge"></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://github.com/chinapandaman/PyPDFForm/raw/master/pdf_samples/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://github.com/chinapandaman/PyPDFForm/raw/master/pdf_samples/adobe_mode/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.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Jinge Li",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/e2/ad/62cb36ee50fe7d87869b88a3c8c704504a6a3c0823a9194864c018b8d80b/pypdfform-3.1.3.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    <a href=\"https://pypi.org/project/PyPDFForm/\"><img src=\"https://img.shields.io/pypi/v/pypdfform?logo=pypi&logoColor=white&label=version&labelColor=black&color=magenta&style=for-the-badge\"></a>\n    <a href=\"https://chinapandaman.github.io/PyPDFForm/\"><img src=\"https://img.shields.io/github/v/release/chinapandaman/pypdfform?logo=read%20the%20docs&logoColor=white&label=docs&labelColor=black&color=cyan&style=for-the-badge\"></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?logo=codecov&logoColor=white&labelColor=black&style=for-the-badge\"></a>\n    <a href=\"https://github.com/chinapandaman/PyPDFForm/raw/master/LICENSE\"><img src=\"https://img.shields.io/github/license/chinapandaman/pypdfform?logo=github&logoColor=white&label=license&labelColor=black&color=orange&style=for-the-badge\"></a>\n    <a href=\"https://www.python.org/downloads/\"><img src=\"https://img.shields.io/pypi/pyversions/pypdfform?logo=python&logoColor=white&label=python&labelColor=black&color=gold&style=for-the-badge\"></a>\n    <a href=\"https://pypistats.org/packages/pypdfform\"><img src=\"https://img.shields.io/pypi/dm/pypdfform?logo=pypi&logoColor=white&label=downloads&labelColor=black&color=blue&style=for-the-badge\"></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://github.com/chinapandaman/PyPDFForm/raw/master/pdf_samples/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://github.com/chinapandaman/PyPDFForm/raw/master/pdf_samples/adobe_mode/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.1.3",
    "project_urls": {
        "Documentation": "https://chinapandaman.github.io/PyPDFForm/",
        "Homepage": "https://github.com/chinapandaman/PyPDFForm"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b7aa3fce79c9ec32b8ba01065fee85fcc0b7e40eda0a4f020665fca102b52c37",
                "md5": "0d789652c932579124d057d99efdfdc4",
                "sha256": "f6b0f09e80d4930bef2a5c6becb4884564f5dba8a6d6145ef9ed877c2c84d794"
            },
            "downloads": -1,
            "filename": "pypdfform-3.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0d789652c932579124d057d99efdfdc4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 109842,
            "upload_time": "2025-07-12T01:21:03",
            "upload_time_iso_8601": "2025-07-12T01:21:03.800528Z",
            "url": "https://files.pythonhosted.org/packages/b7/aa/3fce79c9ec32b8ba01065fee85fcc0b7e40eda0a4f020665fca102b52c37/pypdfform-3.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e2ad62cb36ee50fe7d87869b88a3c8c704504a6a3c0823a9194864c018b8d80b",
                "md5": "1c455149ca84172d804a3042cbd12f51",
                "sha256": "87589272c7e244eb2ca30a7b14a8e7a70e42904a571befbda63d602e42fc4cd3"
            },
            "downloads": -1,
            "filename": "pypdfform-3.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "1c455149ca84172d804a3042cbd12f51",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 107027,
            "upload_time": "2025-07-12T01:21:05",
            "upload_time_iso_8601": "2025-07-12T01:21:05.335789Z",
            "url": "https://files.pythonhosted.org/packages/e2/ad/62cb36ee50fe7d87869b88a3c8c704504a6a3c0823a9194864c018b8d80b/pypdfform-3.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-12 01:21:05",
    "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: 2.40664s