entitylinkage 0.1.0__tar.gz

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

@@ -0,0 +1,70 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  verify:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v7
+
+      - name: Set up Python
+        uses: actions/setup-python@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
+
+      - name: Install locked development dependencies
+        run: uv sync --locked --all-groups
+
+      - name: Lint, format, and test
+        run: |
+          uv run --locked ruff check .
+          uv run --locked ruff format --check .
+          uv run --locked pytest
+
+      - name: Build wheel and source distribution
+        run: uv build
+
+      - name: Install wheel into a clean environment and smoke-test CLI
+        shell: bash
+        run: |
+          set -euo pipefail
+          wheel="$(find dist -maxdepth 1 -type f -name '*.whl' -print -quit)"
+          test -n "$wheel"
+          venv="$RUNNER_TEMP/entitylinkage-wheel"
+          uv venv --python "${{ matrix.python-version }}" "$venv"
+          uv pip install --python "$venv/bin/python" "$GITHUB_WORKSPACE/$wheel"
+          cd "$RUNNER_TEMP"
+          app="$venv/bin/entitylinkage"
+          "$venv/bin/python" -c 'import entitylinkage, pathlib; location = pathlib.Path(entitylinkage.__file__).resolve(); assert "site-packages" in location.parts, location'
+          "$app" validate "$GITHUB_WORKSPACE/examples/basic"
+          "$app" inspect source-record-001 "$GITHUB_WORKSPACE/examples/basic"
+
+          first="$RUNNER_TEMP/linkage-first"
+          second="$RUNNER_TEMP/linkage-second"
+          "$app" link "$GITHUB_WORKSPACE/examples/basic" --output "$first"
+          "$app" link "$GITHUB_WORKSPACE/examples/basic" --output "$second"
+          "$venv/bin/python" -c 'import json, pathlib, sys; summary = json.loads(pathlib.Path(sys.argv[1]).read_text(encoding="utf-8")); assert summary["status_counts"] == {"ambiguous": 1, "not_applicable": 1, "resolved": 1, "unresolved": 1}, summary' "$first/summary.json"
+          set +e
+          "$app" audit "$GITHUB_WORKSPACE/examples/basic"
+          audit_status=$?
+          set -e
+          test "$audit_status" -eq 1
+          cmp "$first/linkage.json" "$second/linkage.json"
+          cmp "$first/linkage.csv" "$second/linkage.csv"
+          cmp "$first/summary.json" "$second/summary.json"

entitylinkage-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,77 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Test and build release distributions
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Check out release tag
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          ref: ${{ github.event.release.tag_name }}
+
+      - name: Set up Python
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: "3.13"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
+
+      - name: Verify release tag matches project version
+        shell: bash
+        run: |
+          expected_tag="v$(uv version --short)"
+          if [[ "$GITHUB_REF_NAME" != "$expected_tag" ]]; then
+            echo "Release tag $GITHUB_REF_NAME does not match package version $expected_tag" >&2
+            exit 1
+          fi
+
+      - name: Install locked development dependencies
+        run: uv sync --locked --all-groups
+
+      - name: Lint, format, and test
+        run: |
+          uv run --locked ruff check .
+          uv run --locked ruff format --check .
+          uv run --locked pytest
+
+      - name: Build distributions
+        run: uv build
+
+      - name: Upload release distributions
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: release-dists
+          path: dist/
+          if-no-files-found: error
+          retention-days: 1
+
+  publish:
+    name: Publish release distributions to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/entitylinkage
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - name: Download release distributions
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2

entitylinkage-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+.worktrees/
+.venv/
+.pytest_cache/
+.ruff_cache/
+dist/
+build/
+__pycache__/
+*.py[cod]

entitylinkage-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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, whether in Source or
+      Object form, 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 any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to 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 otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated 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 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 a Contribution incorporated 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, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, 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 as an addendum 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 copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   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 redistributing 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 consequential 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 any and 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 act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   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 file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

entitylinkage-0.1.0/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.5
+Name: entitylinkage
+Version: 0.1.0
+Summary: Conservative, explainable entity linkage for external records
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: pyyaml<7,>=6.0
+Description-Content-Type: text/markdown
+
+# EntityLinkage
+
+EntityLinkage is a small Python library and command-line tool for linking external records to a canonical set of entities. It makes conservative, explainable decisions from configured identity rules and preserves ambiguity and missing data for review.
+
+> EntityLinkage was extracted from conservative identity-matching patterns developed for a real-world multi-source data pipeline.
+
+## Decisions stay conservative
+
+- **`resolved`** — exactly one candidate remains after all configured constraints.
+- **`ambiguous`** — multiple candidates remain; EntityLinkage does not pick one by score or order.
+- **`unresolved`** — no candidate remains. Reason codes distinguish missing identity information from usable values that matched nothing and from constraints that rejected candidates.
+- **`not_applicable`** — the record is explicitly outside the configured entity scope.
+
+Every result includes candidate IDs, stable reason codes, and evidence for candidate rules, constraints, and any reviewed override. A declared alias is evidence supplied by the configuration; the tool does not invent aliases or use fuzzy matching, external services, or machine learning.
+
+## Install and try the examples
+
+EntityLinkage requires Python 3.11 or newer. From a source checkout, install the locked development environment with [uv](https://docs.astral.sh/uv/):
+
+```sh
+uv sync --locked
+```
+
+You can also install the package from a checkout with `python -m pip install .`. PyYAML is the only runtime dependency.
+
+Validate and link the synthetic basic example:
+
+```sh
+uv run --locked entitylinkage validate examples/basic
+uv run --locked entitylinkage link examples/basic --output ./entitylinkage-output
+uv run --locked entitylinkage inspect source-record-001 examples/basic
+```
+
+`link` writes `linkage.json`, `linkage.csv`, and `summary.json`. It returns success when the reports are written, even when records are ambiguous or unresolved. Use `audit` as a quality gate; it returns exit code 1 when either status occurs:
+
+```sh
+uv run --locked entitylinkage audit examples/basic
+```
+
+The examples under [`examples/`](examples/) use fictional publication and catalog names. They demonstrate alias matching, a year constraint, ambiguity, an unmatched record, an out-of-scope record, and a reviewed manual decision.
+
+## Configuration
+
+Each input is a YAML file or a directory containing `entitylinkage.yaml`. The top-level document has `version: 1`, `entities`, `records`, and `matching`, with an optional `overrides` list. See [`examples/basic/entitylinkage.yaml`](examples/basic/entitylinkage.yaml) for a complete example.
+
+An entity has a unique `id`, a canonical `name`, optional explicit string `aliases`, and optional flat scalar `attributes`. A record has a unique `id`, an optional `name`, flat `attributes`, and an optional `applicable` flag. Attribute keys are user-defined flat field names. Values may be strings, integers, finite floats, booleans, or null; nested mappings and lists are rejected. Quote date-like strings in YAML so they are not parsed as dates. Empty strings are present values for constraints, while omitted and null attribute values are missing.
+
+`matching.normalization` requires `case_fold` and `punctuation` (`preserve`, `remove`, or `space`). Names are normalized with Unicode NFKC, configured punctuation handling, optional case folding, and whitespace collapse. The same settings apply to canonical names, aliases, and record names; normalized record names appear in inspection output.
+
+At least one candidate rule is required:
+
+- `normalized_name` compares a record name with entity names and declared aliases.
+- `exact_value` compares configured `name` or `attributes.<key>` fields using type-sensitive equality. Empty identity values do not create candidates.
+
+Candidate rules are OR-combined: every entity supported by any rule remains a candidate. Constraints are AND-combined and filter each candidate. The `equal` constraint compares fields exactly and requires `missing: ignore` or `missing: reject`. Ignoring a missing value keeps the candidate without treating missing data as match evidence; rejecting it removes the candidate.
+
+## Reviewed overrides
+
+Overrides are intended for explicit reviewed decisions. Set `matching.apply_overrides: true` to enable them. A `resolved` override requires a known `entity_id`; a `not_applicable` override omits it. Both require a stable reason code such as `reviewed_identity_match`. Unknown IDs, duplicate override record IDs, invalid reason codes, disabled overrides, and overrides that contradict an input marked not applicable are rejected. When enabled, a valid override takes precedence over automatic matching and its reason appears in the result evidence.
+
+## Python API
+
+```python
+from pathlib import Path
+
+from entitylinkage import Linker
+from entitylinkage.config import load_config
+
+inputs = load_config(Path("examples/basic"))
+results = Linker(inputs.config).link(inputs.entities, inputs.records)
+for result in results:
+    print(result.record_id, result.status, result.entity_id, result.reason_codes)
+```
+
+The core API accepts `Entity`, `Record`, and `LinkageConfig` values directly; configuration loading, file output, and command-line behavior remain separate from matching. `load_config` rejects duplicate YAML keys, unknown schema keys, malformed scalar values, invalid references, and duplicate normalized labels within one entity. Name or alias collisions across different entities are valid and result in ambiguity when both remain candidates.
+
+## Reports and inspection
+
+The CLI provides four noninteractive commands:
+
+```text
+entitylinkage validate PATH
+entitylinkage link PATH [--output DIR]
+entitylinkage audit PATH
+entitylinkage inspect RECORD_ID PATH
+```
+
+JSON uses stable key ordering and compact encoding. CSV has the fixed columns `record_id,status,entity_id,candidate_entity_ids,reason_codes,evidence`; structured cells contain canonical JSON and rows end with LF. Reports include the EntityLinkage version and Unicode database version, contain no timestamps or filesystem paths, and are byte-identical for equivalent inputs under the same runtime versions. `inspect` shows the input record, normalized record name, rule evidence, candidate IDs, reasons, and final decision.
+
+## Scope and limitations
+
+EntityLinkage performs deterministic exact matching; it does not infer dates, apply domain-specific substitutions, score similarity, or guarantee that declared data is true. Review the evidence and source provenance before using a manual override. Unicode normalization behavior can vary with the runtime's Unicode database version, which is recorded in report metadata.
+
+EntityLinkage can produce mapping evidence for tools such as EvidenceMatrix, which analyzes entity-by-source evidence coverage. It does not require or replace EvidenceMatrix. It also does not provide LineageGuard's artifact provenance and chain-of-custody functions.
+
+The public TWDisaster files currently include event-source relationships and observations already connected to events. Those mappings are not independent labels for validating a source-to-event resolver, so this project does not claim a TWDisaster dogfood result or copy TWDisaster data. See the [read-only review](docs/dogfood/twdisaster.md).
+
+## Development
+
+```sh
+uv run --locked pytest
+uv run --locked ruff check .
+uv run --locked ruff format --check .
+```

entitylinkage-0.1.0/README.md

@@ -0,0 +1,104 @@
+# EntityLinkage
+
+EntityLinkage is a small Python library and command-line tool for linking external records to a canonical set of entities. It makes conservative, explainable decisions from configured identity rules and preserves ambiguity and missing data for review.
+
+> EntityLinkage was extracted from conservative identity-matching patterns developed for a real-world multi-source data pipeline.
+
+## Decisions stay conservative
+
+- **`resolved`** — exactly one candidate remains after all configured constraints.
+- **`ambiguous`** — multiple candidates remain; EntityLinkage does not pick one by score or order.
+- **`unresolved`** — no candidate remains. Reason codes distinguish missing identity information from usable values that matched nothing and from constraints that rejected candidates.
+- **`not_applicable`** — the record is explicitly outside the configured entity scope.
+
+Every result includes candidate IDs, stable reason codes, and evidence for candidate rules, constraints, and any reviewed override. A declared alias is evidence supplied by the configuration; the tool does not invent aliases or use fuzzy matching, external services, or machine learning.
+
+## Install and try the examples
+
+EntityLinkage requires Python 3.11 or newer. From a source checkout, install the locked development environment with [uv](https://docs.astral.sh/uv/):
+
+```sh
+uv sync --locked
+```
+
+You can also install the package from a checkout with `python -m pip install .`. PyYAML is the only runtime dependency.
+
+Validate and link the synthetic basic example:
+
+```sh
+uv run --locked entitylinkage validate examples/basic
+uv run --locked entitylinkage link examples/basic --output ./entitylinkage-output
+uv run --locked entitylinkage inspect source-record-001 examples/basic
+```
+
+`link` writes `linkage.json`, `linkage.csv`, and `summary.json`. It returns success when the reports are written, even when records are ambiguous or unresolved. Use `audit` as a quality gate; it returns exit code 1 when either status occurs:
+
+```sh
+uv run --locked entitylinkage audit examples/basic
+```
+
+The examples under [`examples/`](examples/) use fictional publication and catalog names. They demonstrate alias matching, a year constraint, ambiguity, an unmatched record, an out-of-scope record, and a reviewed manual decision.
+
+## Configuration
+
+Each input is a YAML file or a directory containing `entitylinkage.yaml`. The top-level document has `version: 1`, `entities`, `records`, and `matching`, with an optional `overrides` list. See [`examples/basic/entitylinkage.yaml`](examples/basic/entitylinkage.yaml) for a complete example.
+
+An entity has a unique `id`, a canonical `name`, optional explicit string `aliases`, and optional flat scalar `attributes`. A record has a unique `id`, an optional `name`, flat `attributes`, and an optional `applicable` flag. Attribute keys are user-defined flat field names. Values may be strings, integers, finite floats, booleans, or null; nested mappings and lists are rejected. Quote date-like strings in YAML so they are not parsed as dates. Empty strings are present values for constraints, while omitted and null attribute values are missing.
+
+`matching.normalization` requires `case_fold` and `punctuation` (`preserve`, `remove`, or `space`). Names are normalized with Unicode NFKC, configured punctuation handling, optional case folding, and whitespace collapse. The same settings apply to canonical names, aliases, and record names; normalized record names appear in inspection output.
+
+At least one candidate rule is required:
+
+- `normalized_name` compares a record name with entity names and declared aliases.
+- `exact_value` compares configured `name` or `attributes.<key>` fields using type-sensitive equality. Empty identity values do not create candidates.
+
+Candidate rules are OR-combined: every entity supported by any rule remains a candidate. Constraints are AND-combined and filter each candidate. The `equal` constraint compares fields exactly and requires `missing: ignore` or `missing: reject`. Ignoring a missing value keeps the candidate without treating missing data as match evidence; rejecting it removes the candidate.
+
+## Reviewed overrides
+
+Overrides are intended for explicit reviewed decisions. Set `matching.apply_overrides: true` to enable them. A `resolved` override requires a known `entity_id`; a `not_applicable` override omits it. Both require a stable reason code such as `reviewed_identity_match`. Unknown IDs, duplicate override record IDs, invalid reason codes, disabled overrides, and overrides that contradict an input marked not applicable are rejected. When enabled, a valid override takes precedence over automatic matching and its reason appears in the result evidence.
+
+## Python API
+
+```python
+from pathlib import Path
+
+from entitylinkage import Linker
+from entitylinkage.config import load_config
+
+inputs = load_config(Path("examples/basic"))
+results = Linker(inputs.config).link(inputs.entities, inputs.records)
+for result in results:
+    print(result.record_id, result.status, result.entity_id, result.reason_codes)
+```
+
+The core API accepts `Entity`, `Record`, and `LinkageConfig` values directly; configuration loading, file output, and command-line behavior remain separate from matching. `load_config` rejects duplicate YAML keys, unknown schema keys, malformed scalar values, invalid references, and duplicate normalized labels within one entity. Name or alias collisions across different entities are valid and result in ambiguity when both remain candidates.
+
+## Reports and inspection
+
+The CLI provides four noninteractive commands:
+
+```text
+entitylinkage validate PATH
+entitylinkage link PATH [--output DIR]
+entitylinkage audit PATH
+entitylinkage inspect RECORD_ID PATH
+```
+
+JSON uses stable key ordering and compact encoding. CSV has the fixed columns `record_id,status,entity_id,candidate_entity_ids,reason_codes,evidence`; structured cells contain canonical JSON and rows end with LF. Reports include the EntityLinkage version and Unicode database version, contain no timestamps or filesystem paths, and are byte-identical for equivalent inputs under the same runtime versions. `inspect` shows the input record, normalized record name, rule evidence, candidate IDs, reasons, and final decision.
+
+## Scope and limitations
+
+EntityLinkage performs deterministic exact matching; it does not infer dates, apply domain-specific substitutions, score similarity, or guarantee that declared data is true. Review the evidence and source provenance before using a manual override. Unicode normalization behavior can vary with the runtime's Unicode database version, which is recorded in report metadata.
+
+EntityLinkage can produce mapping evidence for tools such as EvidenceMatrix, which analyzes entity-by-source evidence coverage. It does not require or replace EvidenceMatrix. It also does not provide LineageGuard's artifact provenance and chain-of-custody functions.
+
+The public TWDisaster files currently include event-source relationships and observations already connected to events. Those mappings are not independent labels for validating a source-to-event resolver, so this project does not claim a TWDisaster dogfood result or copy TWDisaster data. See the [read-only review](docs/dogfood/twdisaster.md).
+
+## Development
+
+```sh
+uv run --locked pytest
+uv run --locked ruff check .
+uv run --locked ruff format --check .
+```

entitylinkage-0.1.0/docs/dogfood/twdisaster.md

@@ -0,0 +1,24 @@
+# TWDisaster identity evidence review
+
+**Inspected:** 2026-09-28 (read-only)  
+**Upstream revision:** [`d600dee84d7e9646395d147722e95c7115f81582`](https://github.com/KageRyo/TWDisaster/commit/d600dee84d7e9646395d147722e95c7115f81582), the `main` tip observed during inspection.
+
+## Public model and files
+
+The public data model describes four UTF-8 CSV tables: events, observations, sources, and event-source relationships. At the inspected revision, they contain 76 events, 395 observations, 88 sources, and 89 event-source relationships. Events expose a canonical `name` and `aliases_json`. Sources expose publication metadata including `title` and `url`. Each observation already carries both `event_id` and `source_id`; `event_sources.csv` records source/event pairs that support at least one included observation.
+
+This structure does not provide an independent source-specific event label for EntityLinkage to evaluate. The observation rows already join a source to an event, and the event-source table records that same relationship. Treating either as an input crosswalk would reuse the mapping under evaluation. A source can also support more than one event, so a source title is not necessarily a single-entity identity.
+
+## Read-only title comparison
+
+As a narrow diagnostic, source titles were compared with event names and declared aliases using NFKC normalization, Unicode case folding, and whitespace collapse. One source title exactly matched a canonical event name or alias; that event/source pair was already present in `event_sources.csv`. A substring scan found 36 source titles containing at least one normalized event name or alias; 32 of the resulting event/source pairs were already in the published relationship table. These are candidate-text observations only: substring containment does not establish identity, and the existing crosswalk cannot serve as independent confirmation.
+
+No source rows were copied into this repository, no aliases or mappings were invented, and no private implementation details were inspected. This dataset therefore is not claimed as a TWDisaster dogfood validation. The examples in this project remain fully synthetic. Reassess only if TWDisaster publishes source-specific event identity labels independent of its observation and event-source mappings.
+
+## Sources
+
+- [TWDisaster data model](https://github.com/KageRyo/TWDisaster/blob/main/docs/data-model.md)
+- [events.csv](https://github.com/KageRyo/TWDisaster/blob/main/data/events.csv)
+- [observations.csv](https://github.com/KageRyo/TWDisaster/blob/main/data/observations.csv)
+- [sources.csv](https://github.com/KageRyo/TWDisaster/blob/main/data/sources.csv)
+- [event_sources.csv](https://github.com/KageRyo/TWDisaster/blob/main/data/event_sources.csv)