python-pdffiller 1.0.0__tar.gz

python_pdffiller-1.0.0/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/CHANGELOG.md

@@ -0,0 +1 @@
+# CHANGELOG

python_pdffiller-1.0.0/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/MANIFEST.in

@@ -0,0 +1,7 @@
+include setup.py README.rst MANIFEST.in COPYING pyproject.toml AUTHORS.rst CHANGELOG.md
+include tox.ini requirements*.txt
+
+recursive-include tests *
+include docs/Makefile docs/make.bat
+recursive-include docs/source *
+

python_pdffiller-1.0.0/PKG-INFO

@@ -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/README.rst

@@ -0,0 +1,105 @@
+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/docs/Makefile

@@ -0,0 +1,178 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+SOURCEDIR     = source
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) 
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pdffiller.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pdffiller.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/pdffiller"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pdffiller"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."