PyPDFForm 5.0.0__tar.gz → 5.1.0__tar.gz

{pypdfform-5.0.0 → pypdfform-5.1.0}/PKG-INFO

@@ -1,13 +1,15 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 5.0.0
-Summary: The Python library for PDF forms.
+Version: 5.1.0
+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,24 +17,24 @@ 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.62.1
+Requires-Dist: fonttools<5.0.0,>=4.63.0
 Requires-Dist: pikepdf<11.0.0,>=10.5.1
 Requires-Dist: pillow<13.0.0,>=12.2.0
 Requires-Dist: pypdf<7.0.0,>=6.11.0
-Requires-Dist: reportlab<5.0.0,>=4.5.0
+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: jsonschema<5.0.0,>=4.26.0; extra == "cli"
-Provides-Extra: web-api
-Requires-Dist: fastapi[standard]<1.0.0,>=0.136.1; extra == "web-api"
 Provides-Extra: dev
-Requires-Dist: black<27.0.0,>=26.3.1; 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: isort<9.0.0,>=8.0.1; extra == "dev"
 Requires-Dist: mike<3.0.0,>=2.2.0; extra == "dev"
@@ -42,13 +44,13 @@ Requires-Dist: pudb<2026.0.0,>=2025.1.5; extra == "dev"
 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.0; extra == "dev"
-Requires-Dist: ruff<1.0.0,>=0.15.12; extra == "dev"
+Requires-Dist: requests<3.0.0,>=2.34.2; extra == "dev"
+Requires-Dist: ruff<1.0.0,>=0.15.13; 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>
@@ -61,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
@@ -99,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.0/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.0"
+
+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.0 → pypdfform-5.1.0}/PyPDFForm/cli/common.py

@@ -15,7 +15,7 @@ import typer
 from jsonschema import ValidationError, validate
 
 from .. import PdfWrapper
-from ..shared.utils import WidgetKeyErrorHandler
+from ..lib.middleware.base import Widget
 
 INPUT_PDF = Annotated[
     Path,
@@ -100,23 +100,6 @@ def cli_bad_parameter(
     raise typer.BadParameter(message, param_hint=param_hint) from cause
 
 
-def cli_widget_key_error(param_hint: str) -> WidgetKeyErrorHandler:
-    """
-    Build a CLI error handler for missing form fields.
-
-    Args:
-        param_hint (str): CLI parameter associated with the field name.
-
-    Returns:
-        WidgetKeyErrorHandler: Handler that raises a Typer input error.
-    """
-
-    def _raise_cli_bad_parameter(message: str, cause: KeyError) -> NoReturn:
-        cli_bad_parameter(message, param_hint=param_hint, cause=cause)
-
-    return _raise_cli_bad_parameter
-
-
 def _validation_error_path(exc: ValidationError) -> str:
     """
     Builds a dotted JSON path for a validation error.
@@ -170,6 +153,31 @@ def load_json_file(data: Path, schema: dict, param_hint: str) -> Any:
     return input_data
 
 
+def get_widget(wrapper: PdfWrapper, field: str, param_hint: str) -> Widget:
+    """
+    Look up a widget and report missing names as CLI input errors.
+
+    Args:
+        wrapper (PdfWrapper): PDF wrapper containing form widgets.
+        field (str): Form field name to look up.
+        param_hint (str): CLI parameter associated with the field name.
+
+    Returns:
+        Widget: The matching widget.
+
+    Raises:
+        typer.BadParameter: Raised when the widget name is not present.
+    """
+    try:
+        return wrapper.widgets[field]
+    except KeyError as exc:
+        cli_bad_parameter(
+            f"Form field '{field}' does not exist.",
+            param_hint=param_hint,
+            cause=exc,
+        )
+
+
 def handle_font_registration(
     obj: PdfWrapper, params: dict, registered_font: dict
 ) -> None:

{pypdfform-5.0.0 → pypdfform-5.1.0}/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.0 → pypdfform-5.1.0}/PyPDFForm/cli/inspect.py

@@ -13,8 +13,7 @@ import json
 import typer
 
 from .. import PdfWrapper
-from ..shared.utils import get_widget
-from .common import FIELD_NAME, INPUT_PDF, cli_widget_key_error
+from .common import FIELD_NAME, INPUT_PDF, get_widget
 
 inspect_cli = typer.Typer(
     context_settings={"help_option_names": ["--help", "-h"]}, no_args_is_help=True
@@ -55,9 +54,7 @@ def location(
     field: FIELD_NAME,
 ) -> None:
     """Print a form field's location and size as JSON."""
-    f = get_widget(
-        PdfWrapper(str(pdf), **ctx.obj), field, cli_widget_key_error("--field")
-    )
+    f = get_widget(PdfWrapper(str(pdf), **ctx.obj), field, "--field")
 
     typer.echo(
         json.dumps(

{pypdfform-5.0.0 → pypdfform-5.1.0}/PyPDFForm/cli/schemas/create.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# pylint: disable=R0801
 """
 JSON schemas for the PyPDFForm create CLI commands.
 """

{pypdfform-5.0.0 → pypdfform-5.1.0}/PyPDFForm/cli/schemas/update.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# pylint: disable=R0801
 """
 JSON schemas for the PyPDFForm update CLI commands.
 """

{pypdfform-5.0.0 → pypdfform-5.1.0}/PyPDFForm/cli/update.py

@@ -17,11 +17,9 @@ import typer
 
 from .. import PdfWrapper
 from ..lib.constants import PdfVersion
-from ..shared.utils import get_widget
 from .common import (FIELD_NAME, INPUT_PDF, OPTIONAL_OUTPUT_PDF,
-                     cli_bad_parameter, cli_widget_key_error,
-                     handle_font_registration, json_file_option,
-                     load_json_file)
+                     cli_bad_parameter, get_widget, handle_font_registration,
+                     json_file_option, load_json_file)
 from .schemas.update import FIELD_SCHEMA, RENAME_SCHEMA
 
 update_cli = typer.Typer(
@@ -109,7 +107,7 @@ def bounds(
 ) -> None:
     """Update a form field's position and size."""
     obj = PdfWrapper(str(pdf), **ctx.obj)
-    f = get_widget(obj, widget, cli_widget_key_error("--field"))
+    f = get_widget(obj, widget, "--field")
 
     f.x = x if x is not None else f.x
     f.y = y if y is not None else f.y
@@ -139,7 +137,7 @@ def rename(
     obj = PdfWrapper(str(pdf), **ctx.obj)
     for item in input_data:
         for k, v in item.items():
-            widget = get_widget(obj, k, cli_widget_key_error("--file"))
+            widget = get_widget(obj, k, "--file")
             obj.update_widget_key(widget.name, v["new_key"], index=v.get("index", 0))
 
     obj.commit_widget_key_updates().write(output or pdf)
@@ -160,7 +158,7 @@ def field(
     obj = PdfWrapper(str(pdf), **ctx.obj)
     registered_font = {}
     for k, each in input_data.items():
-        widget = get_widget(obj, k, cli_widget_key_error("--file"))
+        widget = get_widget(obj, k, "--file")
         handle_font_registration(obj, each, registered_font)
         for param, v in each.items():
             setattr(widget, param, v)

{pypdfform-5.0.0 → pypdfform-5.1.0}/PyPDFForm/lib/raw/image.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# pylint: disable=R0801
 """
 Contains the RawImage class, which represents an image that can be drawn
 directly onto a PDF page at a specified position and size.

{pypdfform-5.0.0 → pypdfform-5.1.0}/PyPDFForm/lib/raw/rect.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# pylint: disable=R0801
 """
 Contains the RawRectangle class, which represents a rectangle that can be drawn
 directly onto a PDF page at specified coordinates and dimensions.

{pypdfform-5.0.0 → pypdfform-5.1.0}/PyPDFForm/lib/widgets/dropdown.py

@@ -89,6 +89,7 @@ class DropdownField(Field):
     options: Optional[List[str | Tuple[str, str]]] = None
     width: Optional[float] = None
     height: Optional[float] = None
+    # pylint: disable=R0801
     font: Optional[str] = None
     font_size: Optional[float] = None
     font_color: Optional[Tuple[float, ...]] = None

{pypdfform-5.0.0 → pypdfform-5.1.0}/PyPDFForm/lib/widgets/signature.py

@@ -121,6 +121,7 @@ class SignatureWidget:
             annot_type_to_annot[key] = annot.get_object()
 
         for i, p in enumerate(input_pdf.pages):
+            # pylint: disable=R0801
             watermark = BytesIO()
             canvas = Canvas(
                 watermark,

{pypdfform-5.0.0 → pypdfform-5.1.0}/PyPDFForm.egg-info/PKG-INFO

@@ -1,13 +1,15 @@
 Metadata-Version: 2.4
 Name: PyPDFForm
-Version: 5.0.0
-Summary: The Python library for PDF forms.
+Version: 5.1.0
+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,24 +17,24 @@ 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.62.1
+Requires-Dist: fonttools<5.0.0,>=4.63.0
 Requires-Dist: pikepdf<11.0.0,>=10.5.1
 Requires-Dist: pillow<13.0.0,>=12.2.0
 Requires-Dist: pypdf<7.0.0,>=6.11.0
-Requires-Dist: reportlab<5.0.0,>=4.5.0
+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: jsonschema<5.0.0,>=4.26.0; extra == "cli"
-Provides-Extra: web-api
-Requires-Dist: fastapi[standard]<1.0.0,>=0.136.1; extra == "web-api"
 Provides-Extra: dev
-Requires-Dist: black<27.0.0,>=26.3.1; 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: isort<9.0.0,>=8.0.1; extra == "dev"
 Requires-Dist: mike<3.0.0,>=2.2.0; extra == "dev"
@@ -42,13 +44,13 @@ Requires-Dist: pudb<2026.0.0,>=2025.1.5; extra == "dev"
 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.0; extra == "dev"
-Requires-Dist: ruff<1.0.0,>=0.15.12; extra == "dev"
+Requires-Dist: requests<3.0.0,>=2.34.2; extra == "dev"
+Requires-Dist: ruff<1.0.0,>=0.15.13; 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>
@@ -61,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
@@ -99,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.0 → pypdfform-5.1.0}/PyPDFForm.egg-info/SOURCES.txt

@@ -8,12 +8,6 @@ PyPDFForm.egg-info/dependency_links.txt
 PyPDFForm.egg-info/entry_points.txt
 PyPDFForm.egg-info/requires.txt
 PyPDFForm.egg-info/top_level.txt
-PyPDFForm/api/__init__.py
-PyPDFForm/api/common.py
-PyPDFForm/api/create.py
-PyPDFForm/api/inspect.py
-PyPDFForm/api/root.py
-PyPDFForm/api/update.py
 PyPDFForm/cli/__init__.py
 PyPDFForm/cli/common.py
 PyPDFForm/cli/create.py
@@ -72,8 +66,6 @@ PyPDFForm/lib/widgets/image.py
 PyPDFForm/lib/widgets/radio.py
 PyPDFForm/lib/widgets/signature.py
 PyPDFForm/lib/widgets/text.py
-PyPDFForm/shared/__init__.py
-PyPDFForm/shared/utils.py
 tests/test_bulk_create_fields.py
 tests/test_create_widget.py
 tests/test_draw_elements.py

{pypdfform-5.0.0 → pypdfform-5.1.0}/PyPDFForm.egg-info/requires.txt

@@ -1,16 +1,16 @@
 cryptography<49.0.0,>=48.0.0
-fonttools<5.0.0,>=4.62.1
+fonttools<5.0.0,>=4.63.0
 pikepdf<11.0.0,>=10.5.1
 pillow<13.0.0,>=12.2.0
 pypdf<7.0.0,>=6.11.0
-reportlab<5.0.0,>=4.5.0
+reportlab<5.0.0,>=4.5.1
 
 [cli]
 typer<1.0.0,>=0.25.1
 jsonschema<5.0.0,>=4.26.0
 
 [dev]
-black<27.0.0,>=26.3.1
+black<27.0.0,>=26.5.1
 coverage<8.0.0,>=7.14.0
 isort<9.0.0,>=8.0.1
 mike<3.0.0,>=2.2.0
@@ -20,8 +20,5 @@ pudb<2026.0.0,>=2025.1.5
 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.0
-ruff<1.0.0,>=0.15.12
-
-[web_api]
-fastapi[standard]<1.0.0,>=0.136.1
+requests<3.0.0,>=2.34.2
+ruff<1.0.0,>=0.15.13

{pypdfform-5.0.0 → pypdfform-5.1.0}/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