PyPDFForm 5.0.1__tar.gz → 5.1.1__tar.gz

{pypdfform-5.0.1 → pypdfform-5.1.1}/PKG-INFO

@@ -1,13 +1,15 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 5.0.1
-Summary: The Python library for PDF forms.
+Version: 5.1.1
+Summary: The Python library & CLI for PDF forms.
 Author: Jinge Li
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/chinapandaman/PyPDFForm
 Project-URL: Documentation, https://chinapandaman.github.io/PyPDFForm/
 Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.10
@@ -15,23 +17,25 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
-Classifier: Operating System :: OS Independent
+Classifier: Topic :: File Formats
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing
+Classifier: Topic :: Utilities
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: cryptography<49.0.0,>=48.0.0
 Requires-Dist: fonttools<5.0.0,>=4.63.0
-Requires-Dist: pikepdf<11.0.0,>=10.5.1
+Requires-Dist: pikepdf<11.0.0,>=10.7.2
 Requires-Dist: pillow<13.0.0,>=12.2.0
-Requires-Dist: pypdf<7.0.0,>=6.11.0
+Requires-Dist: pypdf<7.0.0,>=6.12.2
 Requires-Dist: reportlab<5.0.0,>=4.5.1
 Provides-Extra: cli
-Requires-Dist: typer<1.0.0,>=0.25.1; extra == "cli"
+Requires-Dist: typer<1.0.0,>=0.26.1; extra == "cli"
 Requires-Dist: jsonschema<5.0.0,>=4.26.0; extra == "cli"
 Provides-Extra: dev
 Requires-Dist: black<27.0.0,>=26.5.1; extra == "dev"
-Requires-Dist: coverage<8.0.0,>=7.14.0; extra == "dev"
+Requires-Dist: coverage<8.0.0,>=7.14.1; extra == "dev"
 Requires-Dist: isort<9.0.0,>=8.0.1; extra == "dev"
 Requires-Dist: mike<3.0.0,>=2.2.0; extra == "dev"
 Requires-Dist: mkdocs<2.0.0,>=1.6.1; extra == "dev"
@@ -41,12 +45,12 @@ Requires-Dist: pylint<5.0.0,>=4.0.5; extra == "dev"
 Requires-Dist: pyright<2.0.0,>=1.1.409; extra == "dev"
 Requires-Dist: pytest<10.0.0,>=9.0.3; extra == "dev"
 Requires-Dist: requests<3.0.0,>=2.34.2; extra == "dev"
-Requires-Dist: ruff<1.0.0,>=0.15.13; extra == "dev"
+Requires-Dist: ruff<1.0.0,>=0.15.14; extra == "dev"
 Dynamic: license-file
 
 <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>
+    <em>PDF Form Automation Simplified - Create, Inspect, Style, and Fill Forms in Python or from the Command Line.</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>
@@ -59,26 +63,36 @@ Dynamic: license-file
 
 ## Introduction
 
-PyPDFForm is a Python library for PDF form processing. It contains the essential functionalities needed to interact with PDF forms:
+PyPDFForm is a Python library and command line tool for working with PDF forms. It provides Python APIs and CLI commands for creating, inspecting, updating, and filling forms, plus common PDF utilities.
+
+With PyPDFForm, you can:
 
-* 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.
+* Create PDF forms, form fields, and raw elements.
+* Inspect form fields, metadata, and values.
+* Update field styling, behavior, and scripts.
+* Fill PDF forms.
+* Extract pages and merge PDFs.
 
-It also supports other common utilities such as extracting pages and merging multiple PDFs together.
+The goal is to make PDF form work straightforward, whether you are handling one document or building a larger workflow.
 
 ## Installing
 
-Install using [pip](https://pypi.org/project/PyPDFForm/):
+To use PyPDFForm as a Python library, install the base package with [pip](https://pypi.org/project/PyPDFForm/):
 
-```shell script
+```shell
 pip install PyPDFForm
 ```
 
+To use the CLI, install PyPDFForm with the `cli` extra using [pipx](https://pipx.pypa.io/stable/):
+
+```shell
+pipx install "PyPDFForm[cli]"
+```
+
 ## 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/latest/pdfs/sample_template.pdf). Download it and try:
+The GIF above shows the CLI filling a PDF form. To try the same workflow with the Python library, download the [sample PDF form](https://chinapandaman.github.io/PyPDFForm/latest/pdfs/sample_template.pdf) and run:
 
 ```python
 from PyPDFForm import PdfWrapper
@@ -97,8 +111,7 @@ filled = PdfWrapper("sample_template.pdf", need_appearances=True).fill(
 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/latest/pdfs/sample_filled.pdf).
+After running this snippet, `output.pdf` will be written to the location you specified and should look like [this](https://chinapandaman.github.io/PyPDFForm/latest/pdfs/sample_filled.pdf).
 
 ## Documentation
 

pypdfform-5.1.1/PyPDFForm/__init__.py

@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+"""
+PyPDFForm provides Python APIs and CLI commands for working with PDF forms.
+
+It helps users create, inspect, update, and fill PDF forms, plus handle common
+PDF utilities such as extracting pages and merging documents.
+
+The project supports PDF form features including:
+
+- Text, checkbox, radio, dropdown, signature, and image fields.
+- Field styling, sizing, positioning, visibility, and editability.
+- Form data inspection and JSON schema generation.
+- PDF annotations, raw drawing elements, metadata, scripts, and versions.
+
+PyPDFForm aims to make PDF form automation straightforward whether it is used
+from Python code or from the command line.
+"""
+
+import logging
+
+__version__ = "5.1.1"
+
+from .lib.annotations import Annotations
+from .lib.assets.blank import BlankPage
+from .lib.middleware import Widgets
+from .lib.raw import RawElements
+from .lib.types import PdfArray
+from .lib.widgets import Fields
+from .lib.wrapper import PdfWrapper
+
+# TODO: figure out why `Annotation sizes differ:`
+for logger in [
+    logging.getLogger(name) for name in getattr(logging.root.manager, "loggerDict")
+]:
+    if "pypdf" in logger.name:
+        logger.setLevel(logging.ERROR)
+
+__all__ = [
+    "PdfWrapper",
+    "PdfArray",
+    "Annotations",
+    "Fields",
+    "BlankPage",
+    "RawElements",
+    "Widgets",
+]

{pypdfform-5.0.1 → pypdfform-5.1.1}/PyPDFForm/cli/entry.py

@@ -11,7 +11,8 @@ import importlib
 import sys
 
 CLI_DEPENDENCIES = {"jsonschema", "typer"}
-CLI_INSTALL_HINT = "pip install 'PyPDFForm[cli]'"
+CLI_INSTALL_HINT = 'pipx install "PyPDFForm[cli]"'
+CLI_ENV_INSTALL_HINT = "pip install 'PyPDFForm[cli]'"
 
 
 def main() -> None:
@@ -28,7 +29,8 @@ def main() -> None:
         if exc.name in CLI_DEPENDENCIES:
             print(
                 "PyPDFForm CLI dependencies are not installed. "
-                f"Install them with: {CLI_INSTALL_HINT}",
+                f"Install them with: {CLI_INSTALL_HINT}. "
+                f"Inside an existing environment, use: {CLI_ENV_INSTALL_HINT}",
                 file=sys.stderr,
             )
             raise SystemExit(1) from None

{pypdfform-5.0.1 → pypdfform-5.1.1}/PyPDFForm.egg-info/PKG-INFO

@@ -1,13 +1,15 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 5.0.1
-Summary: The Python library for PDF forms.
+Version: 5.1.1
+Summary: The Python library & CLI for PDF forms.
 Author: Jinge Li
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/chinapandaman/PyPDFForm
 Project-URL: Documentation, https://chinapandaman.github.io/PyPDFForm/
 Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.10
@@ -15,23 +17,25 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
-Classifier: Operating System :: OS Independent
+Classifier: Topic :: File Formats
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing
+Classifier: Topic :: Utilities
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: cryptography<49.0.0,>=48.0.0
 Requires-Dist: fonttools<5.0.0,>=4.63.0
-Requires-Dist: pikepdf<11.0.0,>=10.5.1
+Requires-Dist: pikepdf<11.0.0,>=10.7.2
 Requires-Dist: pillow<13.0.0,>=12.2.0
-Requires-Dist: pypdf<7.0.0,>=6.11.0
+Requires-Dist: pypdf<7.0.0,>=6.12.2
 Requires-Dist: reportlab<5.0.0,>=4.5.1
 Provides-Extra: cli
-Requires-Dist: typer<1.0.0,>=0.25.1; extra == "cli"
+Requires-Dist: typer<1.0.0,>=0.26.1; extra == "cli"
 Requires-Dist: jsonschema<5.0.0,>=4.26.0; extra == "cli"
 Provides-Extra: dev
 Requires-Dist: black<27.0.0,>=26.5.1; extra == "dev"
-Requires-Dist: coverage<8.0.0,>=7.14.0; extra == "dev"
+Requires-Dist: coverage<8.0.0,>=7.14.1; extra == "dev"
 Requires-Dist: isort<9.0.0,>=8.0.1; extra == "dev"
 Requires-Dist: mike<3.0.0,>=2.2.0; extra == "dev"
 Requires-Dist: mkdocs<2.0.0,>=1.6.1; extra == "dev"
@@ -41,12 +45,12 @@ Requires-Dist: pylint<5.0.0,>=4.0.5; extra == "dev"
 Requires-Dist: pyright<2.0.0,>=1.1.409; extra == "dev"
 Requires-Dist: pytest<10.0.0,>=9.0.3; extra == "dev"
 Requires-Dist: requests<3.0.0,>=2.34.2; extra == "dev"
-Requires-Dist: ruff<1.0.0,>=0.15.13; extra == "dev"
+Requires-Dist: ruff<1.0.0,>=0.15.14; extra == "dev"
 Dynamic: license-file
 
 <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>
+    <em>PDF Form Automation Simplified - Create, Inspect, Style, and Fill Forms in Python or from the Command Line.</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>
@@ -59,26 +63,36 @@ Dynamic: license-file
 
 ## Introduction
 
-PyPDFForm is a Python library for PDF form processing. It contains the essential functionalities needed to interact with PDF forms:
+PyPDFForm is a Python library and command line tool for working with PDF forms. It provides Python APIs and CLI commands for creating, inspecting, updating, and filling forms, plus common PDF utilities.
+
+With PyPDFForm, you can:
 
-* 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.
+* Create PDF forms, form fields, and raw elements.
+* Inspect form fields, metadata, and values.
+* Update field styling, behavior, and scripts.
+* Fill PDF forms.
+* Extract pages and merge PDFs.
 
-It also supports other common utilities such as extracting pages and merging multiple PDFs together.
+The goal is to make PDF form work straightforward, whether you are handling one document or building a larger workflow.
 
 ## Installing
 
-Install using [pip](https://pypi.org/project/PyPDFForm/):
+To use PyPDFForm as a Python library, install the base package with [pip](https://pypi.org/project/PyPDFForm/):
 
-```shell script
+```shell
 pip install PyPDFForm
 ```
 
+To use the CLI, install PyPDFForm with the `cli` extra using [pipx](https://pipx.pypa.io/stable/):
+
+```shell
+pipx install "PyPDFForm[cli]"
+```
+
 ## 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/latest/pdfs/sample_template.pdf). Download it and try:
+The GIF above shows the CLI filling a PDF form. To try the same workflow with the Python library, download the [sample PDF form](https://chinapandaman.github.io/PyPDFForm/latest/pdfs/sample_template.pdf) and run:
 
 ```python
 from PyPDFForm import PdfWrapper
@@ -97,8 +111,7 @@ filled = PdfWrapper("sample_template.pdf", need_appearances=True).fill(
 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/latest/pdfs/sample_filled.pdf).
+After running this snippet, `output.pdf` will be written to the location you specified and should look like [this](https://chinapandaman.github.io/PyPDFForm/latest/pdfs/sample_filled.pdf).
 
 ## Documentation
 

{pypdfform-5.0.1 → pypdfform-5.1.1}/PyPDFForm.egg-info/requires.txt

@@ -1,17 +1,17 @@
 cryptography<49.0.0,>=48.0.0
 fonttools<5.0.0,>=4.63.0
-pikepdf<11.0.0,>=10.5.1
+pikepdf<11.0.0,>=10.7.2
 pillow<13.0.0,>=12.2.0
-pypdf<7.0.0,>=6.11.0
+pypdf<7.0.0,>=6.12.2
 reportlab<5.0.0,>=4.5.1
 
 [cli]
-typer<1.0.0,>=0.25.1
+typer<1.0.0,>=0.26.1
 jsonschema<5.0.0,>=4.26.0
 
 [dev]
 black<27.0.0,>=26.5.1
-coverage<8.0.0,>=7.14.0
+coverage<8.0.0,>=7.14.1
 isort<9.0.0,>=8.0.1
 mike<3.0.0,>=2.2.0
 mkdocs<2.0.0,>=1.6.1
@@ -21,4 +21,4 @@ pylint<5.0.0,>=4.0.5
 pyright<2.0.0,>=1.1.409
 pytest<10.0.0,>=9.0.3
 requests<3.0.0,>=2.34.2
-ruff<1.0.0,>=0.15.13
+ruff<1.0.0,>=0.15.14

{pypdfform-5.0.1 → pypdfform-5.1.1}/README.md

@@ -1,6 +1,6 @@
 <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>
+    <em>PDF Form Automation Simplified - Create, Inspect, Style, and Fill Forms in Python or from the Command Line.</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>
@@ -13,26 +13,36 @@
 
 ## Introduction
 
-PyPDFForm is a Python library for PDF form processing. It contains the essential functionalities needed to interact with PDF forms:
+PyPDFForm is a Python library and command line tool for working with PDF forms. It provides Python APIs and CLI commands for creating, inspecting, updating, and filling forms, plus common PDF utilities.
 
-* 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.
+With PyPDFForm, you can:
 
-It also supports other common utilities such as extracting pages and merging multiple PDFs together.
+* Create PDF forms, form fields, and raw elements.
+* Inspect form fields, metadata, and values.
+* Update field styling, behavior, and scripts.
+* Fill PDF forms.
+* Extract pages and merge PDFs.
+
+The goal is to make PDF form work straightforward, whether you are handling one document or building a larger workflow.
 
 ## Installing
 
-Install using [pip](https://pypi.org/project/PyPDFForm/):
+To use PyPDFForm as a Python library, install the base package with [pip](https://pypi.org/project/PyPDFForm/):
 
-```shell script
+```shell
 pip install PyPDFForm
 ```
 
+To use the CLI, install PyPDFForm with the `cli` extra using [pipx](https://pipx.pypa.io/stable/):
+
+```shell
+pipx install "PyPDFForm[cli]"
+```
+
 ## 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/latest/pdfs/sample_template.pdf). Download it and try:
+The GIF above shows the CLI filling a PDF form. To try the same workflow with the Python library, download the [sample PDF form](https://chinapandaman.github.io/PyPDFForm/latest/pdfs/sample_template.pdf) and run:
 
 ```python
 from PyPDFForm import PdfWrapper
@@ -51,8 +61,7 @@ filled = PdfWrapper("sample_template.pdf", need_appearances=True).fill(
 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/latest/pdfs/sample_filled.pdf).
+After running this snippet, `output.pdf` will be written to the location you specified and should look like [this](https://chinapandaman.github.io/PyPDFForm/latest/pdfs/sample_filled.pdf).
 
 ## Documentation
 

{pypdfform-5.0.1 → pypdfform-5.1.1}/pyproject.toml

@@ -5,14 +5,16 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "PyPDFForm"
 dynamic = ["version"]
-description = "The Python library for PDF forms."
+description = "The Python library & CLI for PDF forms."
 readme = "README.md"
 authors = [{ name = "Jinge Li" }]
 license = "MIT"
 license-files = ["LICENSE"]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
     "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
     "Programming Language :: Python :: 3.10",
@@ -20,16 +22,18 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3.14",
-    "Operating System :: OS Independent",
+    "Topic :: File Formats",
     "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Text Processing",
+    "Topic :: Utilities",
 ]
 requires-python = ">=3.10"
 dependencies = [
     "cryptography>=48.0.0,<49.0.0",
     "fonttools>=4.63.0,<5.0.0",
-    "pikepdf>=10.5.1,<11.0.0",
+    "pikepdf>=10.7.2,<11.0.0",
     "pillow>=12.2.0,<13.0.0",
-    "pypdf>=6.11.0,<7.0.0",
+    "pypdf>=6.12.2,<7.0.0",
     "reportlab>=4.5.1,<5.0.0",
 ]
 
@@ -39,10 +43,10 @@ Documentation = "https://chinapandaman.github.io/PyPDFForm/"
 
 [project.optional-dependencies]
 # update `CLI_DEPENDENCIES` in `PyPDFForm/cli/entry.py` when changing cli dependencies
-cli = ["typer>=0.25.1,<1.0.0", "jsonschema>=4.26.0,<5.0.0"]
+cli = ["typer>=0.26.1,<1.0.0", "jsonschema>=4.26.0,<5.0.0"]
 dev = [
     "black>=26.5.1,<27.0.0",
-    "coverage>=7.14.0,<8.0.0",
+    "coverage>=7.14.1,<8.0.0",
     "isort>=8.0.1,<9.0.0",
     "mike>=2.2.0,<3.0.0",
     "mkdocs>=1.6.1,<2.0.0",
@@ -52,7 +56,7 @@ dev = [
     "pyright>=1.1.409,<2.0.0",
     "pytest>=9.0.3,<10.0.0",
     "requests>=2.34.2,<3.0.0",
-    "ruff>=0.15.13,<1.0.0",
+    "ruff>=0.15.14,<1.0.0",
 ]
 
 [project.scripts]

pypdfform-5.0.1/PyPDFForm/__init__.py

@@ -1,50 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-PyPDFForm is a pure Python library designed to streamline the process of filling PDF forms programmatically.
-
-It provides a simple and intuitive API for interacting with PDF forms, allowing users to:
-
-- Fill text fields with custom data.
-- Check or uncheck checkboxes.
-- Select radio button options.
-- Add images to image fields.
-- Flatten the filled form to prevent further modifications.
-
-The library supports various PDF form features, including:
-
-- Text field alignment (left, center, right).
-- Font customization (size, color, family).
-- Image field resizing and positioning.
-- Handling of complex form structures.
-
-PyPDFForm aims to simplify PDF form manipulation, making it accessible to developers of all skill levels.
-"""
-
-import logging
-
-__version__ = "5.0.1"
-
-from .lib.annotations import Annotations
-from .lib.assets.blank import BlankPage
-from .lib.middleware import Widgets
-from .lib.raw import RawElements
-from .lib.types import PdfArray
-from .lib.widgets import Fields
-from .lib.wrapper import PdfWrapper
-
-# TODO: figure out why `Annotation sizes differ:`
-for logger in [
-    logging.getLogger(name) for name in getattr(logging.root.manager, "loggerDict")
-]:
-    if "pypdf" in logger.name:
-        logger.setLevel(logging.ERROR)
-
-__all__ = [
-    "PdfWrapper",
-    "PdfArray",
-    "Annotations",
-    "Fields",
-    "BlankPage",
-    "RawElements",
-    "Widgets",
-]