nfield 0.1.0__tar.gz

nfield-0.1.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,33 @@
+name: Bug report
+description: Report a problem with NField
+labels: ["bug"]
+body:
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: A clear description of the bug, including the error message.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Minimal reproduction
+      description: The smallest schema + document + call that reproduces it.
+      render: python
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: NField version
+      placeholder: "0.1.0"
+    validations:
+      required: true
+  - type: input
+    id: python
+    attributes:
+      label: Python version
+      placeholder: "3.12"
+    validations:
+      required: true

nfield-0.1.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,18 @@
+name: Feature request
+description: Suggest an improvement or new capability
+labels: ["enhancement"]
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem
+      description: What are you trying to do that NField does not support today?
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposed solution
+      description: What would the API or behaviour look like?
+    validations:
+      required: false

nfield-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,12 @@
+## Summary
+
+<!-- What does this PR change, and why? -->
+
+## Checklist
+
+- [ ] `uv run ruff check src/ tests/` passes
+- [ ] `uv run ruff format --check src/ tests/` passes
+- [ ] `uv run mypy src/ --strict` passes
+- [ ] `uv run pytest tests/unit/ -q` passes
+- [ ] Added/updated tests for the change
+- [ ] Added a `CHANGELOG.md` entry under `[Unreleased]`

nfield-0.1.0/.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+  # Python dependencies only. GitHub Actions are pinned by major version in the
+  # workflows and updated by hand, so Dependabot does not watch them.
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      python-dependencies:
+        patterns:
+          - "*"

nfield-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,51 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+
+      - uses: astral-sh/setup-uv@v7
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        # All published extras; the benchmark adapters live in the bench dependency
+        # group and stay out of the test environment.
+        run: uv sync --all-extras --dev
+
+      - name: Lint
+        run: |
+          uv run ruff check src/ tests/
+          uv run ruff format --check src/ tests/
+
+      - name: Type check
+        run: uv run mypy src/ --strict
+
+      - name: Test
+        run: uv run pytest tests/unit/ -v --tb=short
+
+      - name: Upload coverage
+        if: matrix.python-version == '3.12'
+        uses: codecov/codecov-action@v7
+        with:
+          fail_ci_if_error: false

nfield-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,38 @@
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+      - uses: astral-sh/setup-uv@v7
+      - name: Build wheel and sdist
+        run: uv build
+      - name: Validate distributions
+        run: uvx twine check --strict dist/*
+      - uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # OIDC trusted publishing - no PYPI_TOKEN secret
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

nfield-0.1.0/.gitignore

@@ -0,0 +1,44 @@
+# Python
+__pycache__/
+*.py[cod]
+*.so
+
+# Distribution
+dist/
+build/
+*.egg-info/
+
+# Virtual environment
+.venv/
+
+# Tools
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.hypothesis/
+.coverage
+htmlcov/
+
+# Environment
+.env
+
+# MkDocs build output
+site/
+
+# Packaging lockfile (keep uv.lock tracked — omit if you prefer not to)
+# uv.lock
+
+# Large downloaded test fixtures (fetched on-demand by integration tests)
+tests/fixtures/documents/_cache/
+tests/fixtures/documents/*.txt
+tests/fixtures/documents/_mtsamples.csv
+tests/fixtures/documents/clinical_note.txt
+
+# Closed-book benchmark source dumps (downloadable; build_fixtures.py lists the URLs and
+# regenerates the committed fixture folders). The fixtures themselves are tracked.
+benchmark/datasets/closed_book/*.json
+benchmark/datasets/closed_book/*.dat
+
+# Benchmark documents are committed for reproducibility (the War & Peace text is
+# public domain, from Project Gutenberg). Benchmark results ARE committed too —
+# raw outputs are the reproducibility evidence — so benchmark/results/ is tracked.

nfield-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.0
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.13.0
+    hooks:
+      - id: mypy
+        args: [--strict]
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: debug-statements

nfield-0.1.0/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+
+Notable changes to nfield. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and versions follow
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-06-27
+
+First public release.
+
+### Added
+- Extract hundreds of structured fields from a document. nfield splits a wide schema
+  into groups that fit the model, retrieves the relevant part of the document for each,
+  validates every value against the text, retries the ones that fail, and reassembles
+  nested JSON.
+- Schemas as a JSON Schema dict, a Pydantic model, or a dataclass.
+- Sync and async API: `nfield`, `nfield_async`, `NField`, `AsyncNField`, plus
+  `extract_batch` for running many documents through one reused engine.
+- Groq and OpenAI-compatible providers. The OpenAI provider's `base_url` reaches any
+  compatible endpoint, hosted (OpenAI, Together, Fireworks, DeepSeek) or local
+  (Ollama, vLLM, LM Studio), so documents can stay on your machine.
+- Reasoning-model support: `ExtractionConfig(reasoning_model=True)` turns off a model's
+  thinking pass per call so it does not eat the answer's output budget.
+- Command-line interface (`nfield extract`, `nfield inspect`) under the `[cli]` extra.
+- Tabular export to pandas or CSV under the `[export]` extra.
+- Fully typed (`py.typed`, `mypy --strict`) with no required dependencies; a provider SDK
+  is pulled in only when you use it.
+- Documentation site and runnable examples.
+
+[Unreleased]: https://github.com/nfield-labs/nfield/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/nfield-labs/nfield/releases/tag/v0.1.0

nfield-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,52 @@
+# Contributing to NField
+
+Thanks for your interest in improving NField. This guide covers the
+development workflow and the two most common extensions: adding a provider and
+adding a pipeline stage.
+
+## Development setup
+
+NField uses [`uv`](https://github.com/astral-sh/uv).
+
+```bash
+uv sync --all-extras --dev
+uv run ruff check src/ tests/
+uv run ruff format --check src/ tests/
+uv run mypy src/ --strict
+uv run pytest tests/unit/ -q
+```
+
+All four must pass before a PR is merged. Integration tests run only when
+`GROQ_API_KEY` is set.
+
+## Conventions
+
+- `src/` layout; every public name is re-exported lazily from a facade `__init__.py`
+  (no implementation in `__init__.py`).
+- Modern typing (`str | None`, `list[int]`); `mypy --strict` clean, no `# type: ignore`.
+- Optional parameters are keyword-only. No magic numbers - name every constant.
+- Every raised error inherits from `NFieldError`.
+- Comments cite published work or name algorithms; they do not reference internal
+  design docs.
+
+## Adding a provider
+
+1. Implement the `LLMProvider` protocol (`providers/_protocol.py`): the async `complete`
+   method plus the `context_window`, `max_output_tokens`, and `model_name` properties.
+   Import the SDK inside the client, not at module top, so `import nfield` stays
+   dependency-free.
+2. Register it in `providers/_registry.py` with a one-line prefix entry, or call
+   `register_provider(provider_prefix, module_path, class_name)`.
+3. Add the SDK as an optional dependency in `pyproject.toml`.
+
+## Adding a pipeline stage
+
+1. Add `pipeline/sN_name.py` exposing a `run_stage_N(state, ...)` function over
+   `PipelineState`. A field belongs on the state only if the next stage reads it.
+2. Wire it into the stage sequence in `engine/_async.py`.
+3. Add unit tests in `tests/unit/pipeline/`.
+
+## Pull requests
+
+- One logical change per PR; add a `CHANGELOG.md` entry under `[Unreleased]`.
+- Include tests for new behaviour.

nfield-0.1.0/LICENSE

@@ -0,0 +1,192 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a cross-claim
+      or counterclaim in a lawsuit) alleging that the Work or any
+      Contribution embodied within the Work constitutes direct or contributory
+      patent infringement, then any patent licenses granted to You under
+      this License for that Work shall terminate as of the date such
+      litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with the
+          Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or in addition to the
+          NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Contribution, either on an "as-is" basis, with no warranties or
+      conditions of any kind, either express or implied, or under other
+      terms and conditions for use, reproduction, and distribution.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may offer only
+      conditions that are consistent with the terms of this License.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the format of the file. We also recommend that
+      a file/directory name and a description of the work be included on
+      the same "page" as the copyright notice for easier identification
+      within third-party archives.
+
+   Copyright 2026 nfield-labs
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

nfield-0.1.0/Makefile

@@ -0,0 +1,34 @@
+.DEFAULT_GOAL := help
+.PHONY: help install lint format typecheck test all docs build clean
+
+help: ## Show this help
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | \
+		awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[36m%-10s\033[0m %s\n", $$1, $$2}'
+
+install: ## Install all extras and dev tooling
+	uv sync --all-extras --dev
+
+lint: ## Check lint and formatting (no changes)
+	uv run ruff check src/ tests/
+	uv run ruff format --check src/ tests/
+
+format: ## Auto-fix lint and apply formatting
+	uv run ruff check --fix src/ tests/
+	uv run ruff format src/ tests/
+
+typecheck: ## Run mypy in strict mode
+	uv run mypy src/ --strict
+
+test: ## Run the unit test suite
+	uv run pytest tests/unit/
+
+all: lint typecheck test ## Lint, type-check, and test
+
+docs: ## Serve the documentation site locally
+	uv run --group docs mkdocs serve
+
+build: ## Build the wheel and sdist
+	uv build
+
+clean: ## Remove build artifacts and tool caches
+	rm -rf dist build ./*.egg-info .pytest_cache .ruff_cache .mypy_cache .coverage htmlcov site