python-pdffiller 1.0.0__py3-none-any.whl

pdffiller/widgets/checkbox.py

@@ -0,0 +1,52 @@
+"""
+Module representing a checkbox widget.
+
+This module defines the Checkbox class, which is a subclass of the
+Widget class. It represents a checkbox form field in a PDF document.
+"""
+
+from typing import Any, Dict, List, Optional
+
+from .base import Widget
+
+
+class CheckBoxWidget(Widget):
+    """
+    Represents a checkbox widget.
+
+    The Checkbox class provides a concrete implementation for
+    checkbox form fields. It inherits from the Widget class and
+    implements the schema_definition and sample_value properties.
+    """
+
+    def __init__(
+        self,
+        name: str,
+        page_number: int,
+        value: Optional[str] = None,
+        choices: Optional[List[str]] = None,
+    ) -> None:
+        """
+        Initializes a checkbox widget.
+
+        Args:
+            name (str): The name of the checkbox.
+            page_number (int): The associated page index
+            value (str): The initial value of the checkbox. Defaults to None.
+            choices: The list of available choices. Defaults to None.
+        """
+        super().__init__(name, page_number, value)
+        self.choices: Optional[List[str]] = choices
+
+    @property
+    def schema_definition(self) -> Dict[str, Any]:
+        """
+        Returns the schema definition for the checkbox.
+
+        The schema definition is a dictionary that describes the
+        data type and other constraints for the checkbox value.
+
+        Returns:
+            dict: A dictionary representing the schema definition.
+        """
+        return {"FieldType": "checkbox", "FieldOptions": self.choices, **super().schema_definition}

pdffiller/widgets/radio.py

@@ -0,0 +1,37 @@
+"""
+Module representing a radio button widget.
+
+This module defines the Radio class, which is a subclass of the
+Checkbox class. It represents a radio button form field in a PDF
+document, allowing users to select one option from a group of choices.
+"""
+
+from typing import Any, Dict
+
+from .checkbox import CheckBoxWidget
+
+
+class RadioWidget(CheckBoxWidget):
+    """
+    Represents a radio button widget.
+
+    The Radio class provides a concrete implementation for radio button
+    form fields. It inherits from the Checkbox class and implements
+    the schema_definition and sample_value properties.
+    """
+
+    @property
+    def schema_definition(self) -> Dict[str, Any]:
+        """
+        Returns the schema definition for the checkbox.
+
+        The schema definition is a dictionary that describes the
+        data type and other constraints for the checkbox value.
+
+        Returns:
+            dict: A dictionary representing the schema definition.
+        """
+        return {
+            **super().schema_definition,
+            "FieldType": "radio",
+        }

pdffiller/widgets/text.py

@@ -0,0 +1,82 @@
+"""
+Module representing a text field widget.
+
+This module defines the Text class, which is a subclass of the
+Widget class. It represents a text field form field in a PDF document,
+allowing users to enter text.
+"""
+
+from typing import Any, Dict, Optional
+
+from .base import Widget
+
+
+class TextWidget(Widget):
+    """
+    Represents a text field widget.
+
+    The Text class provides a concrete implementation for text field
+    form fields. It inherits from the Widget class and implements
+    the value, schema_definition.
+    """
+
+    def __init__(
+        self,
+        name: str,
+        page_number: int,
+        value: Optional[str] = None,
+        max_length: Optional[int] = None,
+    ) -> None:
+        """
+        Initializes a text widget.
+
+        Args:
+            name (str): The name of the checkbox.
+            page_number (int): The associated page index
+            value (str): The initial value of the checkbox. Defaults to None.
+            max_length (int): The maximum length of the text field. Defaults to None.
+        """
+        super().__init__(name, page_number, value)
+        self.max_length: Optional[int] = max_length
+
+    @property
+    def value(self) -> str:
+        """
+        Returns the value of the text field.
+
+        If the value is an integer or float, it is converted to a string.
+
+        Returns:
+            str: The value of the text field.
+        """
+        if isinstance(self._value, (int, float)):
+            return str(self._value)
+
+        return self._value or ""
+
+    @value.setter
+    def value(self, value: Optional[str]) -> None:
+        """
+        Sets the value of the text field.
+
+        Args:
+            value (str): The value to set.
+        """
+        self._value = value
+
+    @property
+    def schema_definition(self) -> Dict[str, Any]:
+        """
+        Returns the schema definition for the checkbox.
+
+        The schema definition is a dictionary that describes the
+        data type and other constraints for the checkbox value.
+
+        Returns:
+            dict: A dictionary representing the schema definition.
+        """
+        schema: Dict[str, Any] = {"FieldType": "text", **super().schema_definition}
+        if self.max_length:
+            schema["MaxLength"] = self.max_length
+
+        return schema

python_pdffiller-1.0.0.dist-info/METADATA

@@ -0,0 +1,138 @@
+Metadata-Version: 2.4
+Name: python-pdffiller
+Version: 1.0.0
+Summary: Interact with PDF by inspecting or filling it
+Author-email: Jacques Raphanel <jraphanel@sismic.fr>
+License-Expression: MIT
+Project-URL: changelog, https://github.com/sismicfr/pypdffiller/blob/main/CHANGELOG.md
+Project-URL: homepage, https://github.com/sismicfr/pypdffiller
+Project-URL: issues, https://github.com/sismicfr/pypdffiller/issues
+Project-URL: repository, http://github.com/sismicfr/pypdffiller.git
+Keywords: development,pdf
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+License-File: COPYING
+License-File: AUTHORS.rst
+Requires-Dist: pypdf
+Requires-Dist: colorama
+Requires-Dist: pyyaml
+Dynamic: license-file
+
+pypdffiller
+===========
+
+|Test| |PyPI| |Python| |Code Style| |Pre-Commit| |License|
+
+``pypdffiller`` 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.
+
+Installation
+------------
+
+As of first version, ``pypdffiller`` is compatible with Python 3.9+.
+
+Use ``pip`` to install the latest stable version of ``pypdffiller``:
+
+.. code-block:: console
+
+   $ pip install --upgrade python-pdffiller
+
+The current development version is available on both `GitHub.com
+<https://github.com/sismicfr/pypdffiller>`__ and can be
+installed directly from the git repository:
+
+.. code-block:: console
+
+   $ pip install git+https://github.com/sismicfr/pypdffiller.git
+
+
+Bug reports
+-----------
+
+Please report bugs and feature requests at
+https://github.com/sismicfr/pypdffiller/issues.
+
+
+Documentation
+-------------
+
+The full documentation for CLI and API is available at https://pypdffiller.readthedocs.org/en/stable/.
+
+Build the docs
+~~~~~~~~~~~~~~
+
+We use ``tox`` to manage our environment and build the documentation:
+
+.. code-block:: console
+
+   $ pip install tox
+   $ tox -e docs
+
+Executable
+----------
+
+In addition to the **Python** package, a standalone executable can be built using **PyInstaller**.
+
+Build the executable
+~~~~~~~~~~~~~~~~~~~~
+
+We use ``tox`` to manage our environment and build the executable:
+
+.. code-block:: console
+
+   $ pip install tox
+   $ tox -e installer
+
+.. code-block:: console
+
+   $ make exe
+
+Contributing
+------------
+
+For guidelines for contributing to ``pypdffiller``, refer to `CONTRIBUTING.rst <https://github.com/sismicfr/pypdffiller/blob/main/CONTRIBUTING.rst>`_.
+
+
+.. |Test| image:: https://github.com/sismicfr/pypdffiller/workflows/Test/badge.svg
+   :target: https://github.com/sismicfr/pypdffiller/actions
+   :alt: Test
+
+.. |PyPI| image:: https://img.shields.io/pypi/v/pypdffiller?label=PyPI&logo=pypi
+   :target: https://badge.fury.io/py/pypdffiller
+   :alt: PyPI
+
+.. |Read the Docs| image:: https://img.shields.io/readthedocs/pypdffiller?label=Documentation&logo=Read%20the%20Docs
+   :target: https://sismicfr.github.io/pypdffiller
+   :alt: Docs
+
+.. |Python| image:: https://img.shields.io/pypi/pyversions/pypdffiller.svg?label=Python&logo=Python
+   :target: https://pypi.python.org/pypi/pypdffiller
+   :alt: Python
+
+.. |Code Style| image:: https://img.shields.io/badge/code%20style-black-000000.svg?label=Code%20Style
+   :target: https://github.com/python/black
+   :alt: Code Style
+
+.. |Pre-Commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&label=Pre-Commit
+   :target: https://github.com/pre-commit/pre-commit
+   :alt: Pre-Commit
+
+.. |License| image:: https://img.shields.io/github/license/sismicfr/pypdffiller?label=License
+   :target: https://github.com/sismicfr/pypdffiller/blob/main/COPYING
+   :alt: License

python_pdffiller-1.0.0.dist-info/RECORD

@@ -0,0 +1,36 @@
+pdffiller/__init__.py,sha256=0HtgXhEV1fKTKAcOXGcq4UsCFflDIPCDQvckshZf-1k,195
+pdffiller/__main__.py,sha256=7NPQgZVx6VSZS7OrmyJQ_O1vL4wiSqhiILi-outwUqM,107
+pdffiller/_version.py,sha256=dVVZYByHt776RZ19IpKaGRcRJNNDSwzljM3Y1DafozI,172
+pdffiller/const.py,sha256=if_j5I8ftczpjrzZjA7idv-XpvIj1-XBF4oe6VtQvF0,434
+pdffiller/exceptions.py,sha256=CdN93bZ0mBBS5vLxg14FYZUy4xkYqoD3_SzqtSkZr4g,1624
+pdffiller/pdf.py,sha256=AfsPcDWoar0N7nRImzpJcgUQ3TyeI8yBZfIv1FYA2Rk,18534
+pdffiller/py.typed.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pdffiller/typing.py,sha256=suxFXOGIF07R8UhrEf-ro_vNA2pXJGfe8CX64dStXTs,954
+pdffiller/utils.py,sha256=pmGf3QwkhKwosk_eFCauzHM-XHp_WGVQAtZlxa7taYY,827
+pdffiller/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pdffiller/cli/args.py,sha256=1MUtxIVgdBWJCjgp2gxUuGW-vH4qne92A7Rns2DylsQ,870
+pdffiller/cli/boolean_action.py,sha256=8Fcd_OuffMWch87CP-TEIQJEDZAh2zJk1gGeBpzTgQw,1294
+pdffiller/cli/cli.py,sha256=ZHGQK6rd3mYzXvSRxAa1PvZgNA6v9pwJCEVtLmOpzPs,9665
+pdffiller/cli/command.py,sha256=9WdP3OywCDRCOv2uyw_mTXIXWIzVoIfsRbkZOh5tnqA,9747
+pdffiller/cli/exit_codes.py,sha256=zjCx3km09qTpooCjRl3RhDJWRWr_WKZKeWFPzcHojko,442
+pdffiller/cli/formatters.py,sha256=k0Y0FaRuHFlW8pxePxGsYA7UEmG-gLkb_H3rFbyTuV4,405
+pdffiller/cli/once_argument.py,sha256=olQvNhObObS0iXVL1YCa-_lH76SV0I4FvnlgR9roqo4,687
+pdffiller/cli/smart_formatter.py,sha256=59hwF07nKbp-P9IfbqKgMFsfbvjIw5SACCZpUF4nnuE,318
+pdffiller/cli/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pdffiller/cli/commands/dump_data_fields.py,sha256=YR8aENCGkCRro0jTuuvMg2HCEos9aF81aL4SxP--_2E,2262
+pdffiller/cli/commands/fill_form.py,sha256=QylVT7cSMbH5FjdNqOtU_eVL9tWQjCceroZ7A2152Q0,4668
+pdffiller/io/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pdffiller/io/colors.py,sha256=QCBEWksTVNurOJQYO0zh1X_xxIOXxXmYSJhbCqnNjI8,1710
+pdffiller/io/output.py,sha256=NWV1SabnR_kXmR8tfUKQQoQ_3RV9wqiSnHqzinQDgB0,11217
+pdffiller/widgets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pdffiller/widgets/base.py,sha256=HosjtNWOXRVjCidZZYlWN7Y_M9Ft1P-F4G3EyluUI3I,2901
+pdffiller/widgets/checkbox.py,sha256=6kBSN7sc6uzujAFzfC_HO8SvtiK736ym7hdPBIR1eT4,1603
+pdffiller/widgets/radio.py,sha256=Db9Oc3Q8ge8qqTVPLoz3I1_SJBGyJ8KfA33ixZMr78c,1070
+pdffiller/widgets/text.py,sha256=JsluVKl7ZNj5_UZI9rL4MSOd6rLiPxSggHH3g9raUJI,2289
+python_pdffiller-1.0.0.dist-info/licenses/AUTHORS.rst,sha256=1_hVzMKgmoXvGgrcZC7sIbU_6PvvkB6vwqevAqzrIkQ,205
+python_pdffiller-1.0.0.dist-info/licenses/COPYING,sha256=ADPe-bH2wYq8nFf6EPJyovzTJyl3jSPnm09mGI8FSTo,1074
+python_pdffiller-1.0.0.dist-info/METADATA,sha256=JxmTx9WQJxJWNfvpaMAhpRsJqr1pomUlSuCWmvIXSd4,4319
+python_pdffiller-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+python_pdffiller-1.0.0.dist-info/entry_points.txt,sha256=RESKKpPPdWl0wDET96ntuFoUydALx9j0mxtbt-MEBjU,49
+python_pdffiller-1.0.0.dist-info/top_level.txt,sha256=5MGWCBFYlu_Ax-I5PgQkV9Xw7O48maPe9z8Qj_yVPL4,10
+python_pdffiller-1.0.0.dist-info/RECORD,,

python_pdffiller-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

python_pdffiller-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pdffiller = pdffiller.cli:main

python_pdffiller-1.0.0.dist-info/licenses/AUTHORS.rst

@@ -0,0 +1,7 @@
+Contributors
+------------
+
+|contributors|
+
+.. |contributors| image:: https://contributors-img.web.app/image?repo=sismicfr/pypdffiller
+   :target: https://github.com/sismicfr/pypdffiller/graphs/contributors

python_pdffiller-1.0.0.dist-info/licenses/COPYING

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 SISMIC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

python_pdffiller-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pdffiller