extractforms 0.1.0__tar.gz

extractforms-0.1.0/.gitignore

@@ -0,0 +1,277 @@
+# File created using '.gitignore Generator' for Visual Studio Code: https://bit.ly/vscode-gig
+# Created by https://www.toptal.com/developers/gitignore/api/visualstudiocode,macos,dotenv,linux,python,windows
+# Edit at https://www.toptal.com/developers/gitignore?templates=visualstudiocode,macos,dotenv,linux,python,windows
+
+### dotenv ###
+.env
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,macos,dotenv,linux,python,windows
+
+# Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
+
+data/*
+results/*

extractforms-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+
+MIT License
+
+Copyright (c) Guillaume Lombardo
+
+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.

extractforms-0.1.0/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: extractforms
+Version: 0.1.0
+Summary: A python project to turn scanned forms into a list of key-value pairs.
+Project-URL: Homepage, https://github.com/Guillaume-Lombardo/extractforms
+Project-URL: Repository, https://github.com/Guillaume-Lombardo/extractforms
+Project-URL: Issues, https://github.com/Guillaume-Lombardo/extractforms/issues
+Author-email: Guillaume Lombardo <g1lom@later.day>
+License: MIT
+License-File: LICENSE
+Keywords: automation,cli,package,python
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.13
+Requires-Dist: certifi>=2026.1.4
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: openai>=2.1.0
+Requires-Dist: pydantic-settings>=2.13.0
+Requires-Dist: pydantic>=2.12.0
+Requires-Dist: pymupdf>=1.26.5
+Requires-Dist: python-dotenv>=1.1.0
+Requires-Dist: structlog>=25.5.0
+Description-Content-Type: text/markdown
+
+# ExtractForms
+
+`extractforms` is a Python package and CLI to extract key/value fields from PDF forms.
+
+## Quickstart
+
+```bash
+uv sync --group dev
+uv run pre-commit install
+uv run ruff format .
+uv run ruff check .
+uv run ty check src tests
+uv run pytest
+uv run pre-commit run --all-files
+```
+
+## CLI
+
+```bash
+extractforms extract --input form.pdf --output results/result.json --passes 2
+```
+
+Supported options include:
+- `--no-cache`
+- `--dpi`, `--image-format`, `--page-start`, `--page-end`, `--max-pages`
+- `--chunk-pages`
+- `--extra-instructions`
+- `--schema-id`, `--schema-path`, `--match-schema`
+
+## Environment
+
+Copy `.env.template` to `.env` and configure:
+- logging (`LOG_LEVEL`, `LOG_JSON`, `LOG_FILE`)
+- enterprise network/TLS (`HTTP_PROXY`, `HTTPS_PROXY`, `ALL_PROXY`, `NO_PROXY`, `CERT_PATH`)
+- model endpoint (`OPENAI_BASE_URL`, `OPENAI_API_KEY`, `OPENAI_MODEL`)
+
+## Project Layout
+
+- `src/extractforms`: package code
+- `tests/unit`: fast default tests
+- `tests/integration`: component-level tests
+- `tests/end2end`: user-facing behavior tests
+- `skills`: AI helper skills for coding workflows
+
+## Release
+
+1. Bump `version` in `pyproject.toml`.
+2. Create and push a git tag: `vX.Y.Z`.
+3. GitHub Action publishes to PyPI.
+
+For manual validation, use workflow dispatch with `publish_target=testpypi`.

extractforms-0.1.0/README.md

@@ -0,0 +1,51 @@
+# ExtractForms
+
+`extractforms` is a Python package and CLI to extract key/value fields from PDF forms.
+
+## Quickstart
+
+```bash
+uv sync --group dev
+uv run pre-commit install
+uv run ruff format .
+uv run ruff check .
+uv run ty check src tests
+uv run pytest
+uv run pre-commit run --all-files
+```
+
+## CLI
+
+```bash
+extractforms extract --input form.pdf --output results/result.json --passes 2
+```
+
+Supported options include:
+- `--no-cache`
+- `--dpi`, `--image-format`, `--page-start`, `--page-end`, `--max-pages`
+- `--chunk-pages`
+- `--extra-instructions`
+- `--schema-id`, `--schema-path`, `--match-schema`
+
+## Environment
+
+Copy `.env.template` to `.env` and configure:
+- logging (`LOG_LEVEL`, `LOG_JSON`, `LOG_FILE`)
+- enterprise network/TLS (`HTTP_PROXY`, `HTTPS_PROXY`, `ALL_PROXY`, `NO_PROXY`, `CERT_PATH`)
+- model endpoint (`OPENAI_BASE_URL`, `OPENAI_API_KEY`, `OPENAI_MODEL`)
+
+## Project Layout
+
+- `src/extractforms`: package code
+- `tests/unit`: fast default tests
+- `tests/integration`: component-level tests
+- `tests/end2end`: user-facing behavior tests
+- `skills`: AI helper skills for coding workflows
+
+## Release
+
+1. Bump `version` in `pyproject.toml`.
+2. Create and push a git tag: `vX.Y.Z`.
+3. GitHub Action publishes to PyPI.
+
+For manual validation, use workflow dispatch with `publish_target=testpypi`.

extractforms-0.1.0/docs/adr/README.md

@@ -0,0 +1,17 @@
+# Architecture Decision Records (ADR)
+
+## Why ADRs
+
+- Track architectural decisions.
+- Preserve context and rejected alternatives.
+- Improve onboarding and future reviews.
+
+## Naming convention
+
+- `NNNN-short-title.md`
+- Example: `0001-http-client-choice.md`
+
+## Process
+
+- Create an ADR for any long-term architectural decision.
+- Link the ADR in the corresponding PR.

extractforms-0.1.0/docs/engineering/README.md

@@ -0,0 +1,7 @@
+# Engineering Docs
+
+- [Definition of Done](./DEFINITION_OF_DONE.md)
+- [Review Runbook](./REVIEW_RUNBOOK.md)
+- [ADR](../adr/README.md)
+- [Review Guide](../../.github/review/REVIEW_GUIDE.md)
+- [Repo Coherence Playbook](../../.github/review/REPO_COHERENCE_PLAYBOOK.md)

extractforms-0.1.0/pyproject.toml

@@ -0,0 +1,90 @@
+[project]
+  name = "extractforms"
+  version = "0.1.0"
+  description = "A python project to turn scanned forms into a list of key-value pairs."
+  readme = "README.md"
+  requires-python = ">=3.13"
+  authors = [
+    { name = "Guillaume Lombardo", email = "g1lom@later.day" },
+  ]
+  license = { text = "MIT" }
+  keywords = ["automation", "cli", "package", "python"]
+  classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+  ]
+  dependencies = [
+    "certifi>=2026.1.4",
+    "httpx>=0.28.1",
+    "openai>=2.1.0",
+    "pydantic-settings>=2.13.0",
+    "pydantic>=2.12.0",
+    "pymupdf>=1.26.5",
+    "python-dotenv>=1.1.0",
+    "structlog>=25.5.0",
+  ]
+
+[dependency-groups]
+  dev = [
+    "build>=1.3.0",
+    "detect-secrets>=1.5.0",
+    "pre-commit>=4.5.1",
+    "pytest-cov>=7.0.0",
+    "pytest-mock>=3.15.1",
+    "pytest>=9.0.2",
+    "ruff>=0.15.0",
+    "twine>=6.2.0",
+    "ty>=0.0.15",
+  ]
+
+  [project.urls]
+    Homepage = "https://github.com/Guillaume-Lombardo/extractforms"
+    Repository = "https://github.com/Guillaume-Lombardo/extractforms"
+    Issues = "https://github.com/Guillaume-Lombardo/extractforms/issues"
+
+  [project.scripts]
+    extractforms = "extractforms.cli:main"
+
+[build-system]
+  requires = ["hatchling>=1.27.0"]
+  build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+  packages = ["src/extractforms"]
+
+[tool.hatch.build.targets.sdist]
+  include = [
+    "LICENSE",
+    "README.md",
+    "pyproject.toml",
+    "src/extractforms",
+  ]
+
+[tool.pytest.ini_options]
+  minversion = "9.0"
+  testpaths = ["tests"]
+  addopts = "-ra -q -m unit --strict-markers --cov=src --cov-report=term-missing:skip-covered --cov-report=html"
+  pythonpath = ["src"]
+  markers = [
+    "end2end: mark a test as an end-to-end test.",
+    "integration: mark a test as an integration test.",
+    "unit: mark a test as a unit test.",
+  ]
+
+[tool.coverage.run]
+  branch = true
+  source = ["src/extractforms"]
+  omit = ["*/tests/*"]
+
+[tool.coverage.report]
+  show_missing = true
+  skip_covered = true
+  precision = 2
+  fail_under = 80
+
+[tool.coverage.html]
+  directory = "htmlcov"
+  title = "ExtractForms coverage"

extractforms-0.1.0/src/extractforms/__init__.py

@@ -0,0 +1,32 @@
+"""ExtractForms package."""
+
+from extractforms._bootstrap import logger
+from extractforms.async_runner import run_async
+from extractforms.exceptions import (
+    AsyncExecutionError,
+    BackendError,
+    DependencyError,
+    ExtractionError,
+    PackageError,
+    SettingsError,
+)
+from extractforms.logging import configure_logging, get_logger
+from extractforms.settings import Settings, get_settings
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "AsyncExecutionError",
+    "BackendError",
+    "DependencyError",
+    "ExtractionError",
+    "PackageError",
+    "Settings",
+    "SettingsError",
+    "__version__",
+    "configure_logging",
+    "get_logger",
+    "get_settings",
+    "logger",
+    "run_async",
+]

extractforms-0.1.0/src/extractforms/_bootstrap.py

@@ -0,0 +1,10 @@
+"""Package bootstrap helpers."""
+
+from extractforms.dependencies import ensure_package_dependencies
+from extractforms.logging import get_logger
+
+ensure_package_dependencies()
+
+logger = get_logger("extractforms")
+
+__all__ = ["logger"]

extractforms-0.1.0/src/extractforms/async_runner.py

@@ -0,0 +1,64 @@
+"""Helpers to run async operations from sync or async contexts."""
+
+from __future__ import annotations
+
+import asyncio
+import threading
+from queue import Queue
+from typing import TYPE_CHECKING, Any
+
+from extractforms.exceptions import AsyncExecutionError
+
+if TYPE_CHECKING:
+    from collections.abc import Coroutine
+
+
+def _run_in_background_thread[T](coro: Coroutine[Any, Any, T]) -> T:
+    """Run a coroutine in a dedicated thread with its own event loop.
+
+    Args:
+        coro (Coroutine[Any, Any, T]): The coroutine to run.
+
+    Raises:
+        AsyncExecutionError: If the coroutine raises an exception.
+
+    Returns:
+        T: The result of the coroutine.
+    """
+    output: Queue[T | BaseException] = Queue(maxsize=1)
+
+    def _runner() -> None:
+        try:
+            output.put(asyncio.run(coro))
+        except BaseException as exc:
+            output.put(exc)
+
+    thread = threading.Thread(target=_runner, daemon=True)
+    thread.start()
+    thread.join()
+
+    result = output.get()
+    if isinstance(result, BaseException):
+        raise AsyncExecutionError(result=result) from result
+    return result
+
+
+def run_async[T](coro: Coroutine[Any, Any, T]) -> T:
+    """Run an async coroutine from both sync and async contexts.
+
+    If called from a sync context, the coroutine will be run in a dedicated thread
+    with its own event loop. If called from an async context, the coroutine will
+    be awaited directly.
+
+    Args:
+        coro (Coroutine[Any, Any, T]): The coroutine to run.
+
+    Returns:
+        T: The result of the coroutine.
+    """
+    try:
+        asyncio.get_running_loop()
+    except RuntimeError:
+        return asyncio.run(coro)
+
+    return _run_in_background_thread(coro)

extractforms-0.1.0/src/extractforms/backends/__init__.py

@@ -0,0 +1,7 @@
+"""Extraction backends."""
+
+from extractforms.backends.multimodal_openai import MultimodalLLMBackend
+from extractforms.backends.ocr_document_intelligence import OCRBackend
+from extractforms.typing.protocol import ExtractorBackend, PageSource
+
+__all__ = ["ExtractorBackend", "MultimodalLLMBackend", "OCRBackend", "PageSource"]