tieout 0.1.0__tar.gz

tieout-0.1.0/.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 4
+
+[*.{yaml,yml,toml,json,md}]
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

tieout-0.1.0/.gitattributes

@@ -0,0 +1,5 @@
+* text=auto eol=lf
+
+# Fixture files must stay byte-exact: their hashes are part of run metadata.
+tests/fixtures/** -text
+examples/**/data/** -text

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

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Python ${{ matrix.python }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python: ["3.11", "3.12", "3.13"]
+        include:
+          - os: windows-latest
+            python: "3.12"
+          - os: macos-latest
+            python: "3.12"
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python }}
+      - run: uv sync --locked
+      - run: uv run ruff format --check .
+      - run: uv run ruff check .
+      - run: uv run mypy
+      - run: uv run pytest

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

@@ -0,0 +1,78 @@
+name: Release
+
+# Push a tag such as v0.1.0 to build, test and publish a GitHub release.
+# Publishing to PyPI uses trusted publishing and stays off until the repository
+# variable PYPI_PUBLISH is set to "true" and a trusted publisher is configured on
+# pypi.org for this workflow and the "pypi" environment.
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.12"
+      - name: Check the tag matches the package version
+        run: |
+          version=$(python3 -c "import tomllib; print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
+          test "v${version}" = "${GITHUB_REF_NAME}" || { echo "tag ${GITHUB_REF_NAME} != v${version}"; exit 1; }
+      - run: uv sync --locked
+      - run: uv run pytest
+      - run: uv build
+      - name: Smoke-test the wheel
+        run: |
+          uv venv /tmp/smoke
+          uv pip install --python /tmp/smoke dist/*.whl
+          /tmp/smoke/bin/tieout --version
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  github-release:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Extract release notes from the changelog
+        run: |
+          version="${GITHUB_REF_NAME#v}"
+          awk -v v="$version" '
+            $0 ~ "^## \\[" v "\\]" { found = 1; next }
+            found && /^## \[/ { exit }
+            found && /^\[[^]]+\]: / { exit }
+            found { print }
+          ' CHANGELOG.md > notes.md
+          test -s notes.md
+      - name: Create the release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: gh release create "$GITHUB_REF_NAME" dist/* --title "$GITHUB_REF_NAME" --notes-file notes.md --verify-tag
+
+  pypi:
+    needs: build
+    if: vars.PYPI_PUBLISH == 'true'
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

tieout-0.1.0/.gitignore

@@ -0,0 +1,28 @@
+# Private planning material, not part of the open-source project
+/archive/
+
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.venv/
+
+# Tooling caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.hypothesis/
+.coverage
+htmlcov/
+
+# Local run output
+/out/
+/results/
+
+# Editors and OS
+.idea/
+.vscode/
+.DS_Store
+Thumbs.db

tieout-0.1.0/CHANGELOG.md

@@ -0,0 +1,51 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project uses
+[Semantic Versioning](https://semver.org/). Before 1.0, minor versions may change
+the rule format and the Python API.
+
+## [0.1.0] - 2026-11-15
+
+First public release.
+
+### Added
+
+- Matching engine with `one_to_one`, `one_to_many` and `many_to_one` rules:
+  amount tolerance and sign conventions, date windows on value or booking date,
+  normalised reference checks, and grouping by shared key or bounded subset search.
+- Connectors for generic CSV, ISO 20022 camt.053 / camt.054, and Stripe itemized
+  payout reconciliation reports.
+- `tieout validate` and `tieout run` commands with a terminal summary, JSON and
+  CSV reports, and `--fail-on-breaks` for CI use.
+- YAML specs validated strictly: unknown keys, duplicate keys, impossible date
+  windows and rule fields a source cannot produce are rejected before any input
+  is read.
+
+### Guarantees
+
+- **Exact money.** Integer minor units, scaled by the ISO 4217 exponent
+  (list of 2026-09-17). Unknown currencies, unrepresentable amounts (`10.005 USD`),
+  malformed digit grouping and non-ASCII digits are errors, never roundings.
+  `register_currency()` declares private or crypto codes.
+- **No guessing.** Pairs match only as mutual unique best candidates; ties become
+  `ambiguous` breaks with their candidates. A subset-search group is refused when
+  another target could also claim one of its members.
+- **Every record accounted for.** Each record is in exactly one match or one break,
+  and rows a connector filters out are listed with their location. The invariants
+  are re-checked at the end of every run.
+- **Reproducible.** Record ids come from natural keys or content, so shuffled input
+  rows give the same matches, breaks and run id. Raw-file SHA-256 digests are kept
+  in the run log. Search limits count steps, not seconds.
+- **Fail-closed parsing.** Hostile XML, duplicate, missing or misaligned CSV
+  columns, unbalanced quotes, and camt statements whose balances or `TxsSummry`
+  totals don't add up are rejected with the file and line or entry. A missing
+  value date is never filled in from the booking date.
+- **Correct dates and signs.** Stripe `*_utc` columns are preferred, other columns
+  need `report_timezone`; camt reversals follow ISO 20022 (`CdtDbtInd` is the
+  entry's own direction), with `reversal_sign: flipped` for banks that differ.
+- **Explained and safe output.** Every match states its rule, totals, residual,
+  date gap and the reference values that agreed. CSV reports neutralise
+  spreadsheet formulas in text cells.
+
+[0.1.0]: https://github.com/Vinay-K-Rajith/tieout/releases/tag/v0.1.0

tieout-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

tieout-0.1.0/PKG-INFO

@@ -0,0 +1,177 @@
+Metadata-Version: 2.5
+Name: tieout
+Version: 0.1.0
+Summary: Open-source reconciliation engine: match bank, payment-provider, ledger and invoice records, with every match explained.
+Project-URL: Homepage, https://github.com/Vinay-K-Rajith/tieout
+Project-URL: Issues, https://github.com/Vinay-K-Rajith/tieout/issues
+Author: Vinay K Rajith
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: accounting,camt.053,finance,ledger,reconciliation,stripe
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Financial :: Accounting
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: click>=8.1
+Requires-Dist: defusedxml>=0.7.1
+Requires-Dist: pydantic>=2.7
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: tzdata>=2024.1; sys_platform == 'win32'
+Description-Content-Type: text/markdown
+
+# tieout
+
+**An open-source reconciliation engine.** tieout matches money records across bank
+statements, payment-provider reports, ledgers and invoices, and explains every match.
+Anything it can't match with certainty comes back as a *break* with the reason. It
+never guesses.
+
+> Status: alpha (v0.1). The rule format and Python API may still change before v1.0.
+> See the [changelog](CHANGELOG.md).
+
+## Why
+
+Every company that moves money has to prove its records agree: bank vs ledger,
+Stripe payouts vs orders, invoices vs incoming payments. That work is still mostly
+spreadsheets, and every fintech writes its own matcher. The open-source finance stack
+has ledgers, payments, billing and AML, but no standalone reconciliation engine.
+See [docs/design/PRODUCT.md](docs/design/PRODUCT.md) for the full case.
+
+## What it guarantees
+
+- **Exact money.** Amounts are integer minor units, scaled by the ISO 4217 exponent
+  of a currency that must exist (`USX` or `XAU` is an error, not "2 decimals").
+  A value that can't be represented exactly (`10.005 USD`) is an error, never a
+  rounding, and so is misplaced digit grouping (`1,23` read with `,` as the
+  thousands separator).
+- **No guessing.** A pair is matched only when each side is the other's unique best
+  candidate. Ties are reported as `ambiguous` breaks, with the candidates listed.
+  A group found by subset search is refused if any other target could also use
+  one of its members.
+- **Every record is accounted for.** Each input record ends up in exactly one match
+  or one break, duplicates included, and rows a connector filters out on purpose
+  (pending bank entries, Stripe payout lines) are listed with their location.
+  These invariants are re-checked at the end of every run; a violation aborts the
+  run instead of returning numbers that cannot be right.
+- **Every match is explained.** The rule, the amounts, the date gap and the
+  reference values that agreed are all recorded in plain language.
+- **Reproducible.** The same inputs, spec and engine version give the same output and
+  the same run id, even if the rows of a file are shuffled: record ids come from
+  content or natural keys, never from line numbers. The run log keeps the SHA-256
+  of each raw file as well. Search limits count steps, not seconds.
+- **Fail-closed parsing.** Hostile XML, duplicate or missing CSV columns, short or
+  long rows, unbalanced quotes, and camt statements whose balances or totals don't
+  add up are rejected with the file and line or entry. A missing value date is
+  left missing, never filled in from the booking date.
+- **Strict specs.** Unknown keys, duplicate YAML keys, impossible date windows and
+  rule fields a source cannot produce (`group: { by: payout_idd }`) fail before a
+  single record is read.
+
+## Quick start
+
+```bash
+pip install git+https://github.com/Vinay-K-Rajith/tieout@v0.1.0
+tieout run examples/stripe-to-bank/recon.yaml \
+  --input stripe=examples/stripe-to-bank/data/stripe_itemized_payouts.csv \
+  --input bank=examples/stripe-to-bank/data/bank_statement.camt053.xml
+```
+
+A spec declares sources and rules:
+
+```yaml
+version: 1
+sources:
+  stripe: { format: stripe }
+  bank:   { format: camt }
+rules:
+  # All Stripe balance transactions of one payout must add up to one bank credit.
+  - id: payout-to-bank
+    left: stripe
+    right: bank
+    kind: many_to_one
+    group: { by: payout_id }
+    date: { min_days: 0, max_days: 4 }
+```
+
+Or from Python:
+
+```python
+from tieout import load_spec, reconcile
+from tieout.connectors import read_source
+
+spec = load_spec("recon.yaml")
+sources = [read_source(name, path, spec.sources[name]) for name, path in inputs.items()]
+result = reconcile(sources, spec)
+
+for match in result.matches:
+    print(match.rule_id, match.left_ids, match.right_ids, *match.explanation, sep="\n  ")
+for item in result.breaks:
+    print(item.record_id, item.reason, item.detail)
+```
+
+## Rules
+
+| Kind | Meaning |
+|---|---|
+| `one_to_one` | One left record against one right record |
+| `one_to_many` | One left record equals the sum of several right records |
+| `many_to_one` | Several left records sum to one right record |
+
+Conditions, all optional:
+
+| Condition | Example | Meaning |
+|---|---|---|
+| `amount` | `{ tolerance: 50, sign: opposite }` | Totals agree within 50 minor units; `opposite` when the two sources use opposite signs |
+| `date` | `{ min_days: 0, max_days: 3 }` | Right date minus left date is 0 to 3 days, for every record pair |
+| `references` | `[{ left: invoice_no, right: description, op: left_in_right }]` | Normalised references agree (case and punctuation ignored). Containment matches whole tokens only, and needles shorter than `min_length` (default 4) never match: `INV-0042` is found in `Payment for inv 0042`, `7712` is not found in `Payment #77712` |
+| `group` | `{ by: payout_id }` or `{ max_size: 4 }` | Group by a shared field, or search for subsets of up to 4 records |
+
+Rules run in `priority` order (lower first). Put exact rules before tolerant ones.
+
+## Connectors
+
+| Format | `format:` | Notes |
+|---|---|---|
+| Any CSV, with a column mapping | `csv` | Signed amount column or separate inflow/outflow columns; configurable separators and date format |
+| ISO 20022 camt.053 / camt.054 | `camt` | Booked entries by default; one record per entry. Checks opening + entries = closing balance and `TxsSummry` (`verify_balances: false` to skip). `RvslInd` marks a reversal but does not flip the sign: per ISO, `CdtDbtInd` already gives the entry's direction. For a bank that puts the original entry's direction there instead, set `reversal_sign: flipped`; the balance checks reject the wrong setting |
+| Stripe itemized payout reconciliation report | `stripe` | Net amounts, grouped by payout. Dates are taken in `timezone`; `*_utc` columns are preferred, and other columns need `report_timezone` (the zone the report was requested in) unless both are UTC |
+
+## Project layout
+
+```
+src/tieout/
+  money.py           exact amounts and currencies
+  records.py         the canonical Record and Source
+  spec.py            the YAML spec: sources and rules
+  conditions.py      what each rule condition means, and how it is explained
+  matching.py        candidate search and mutual-best resolution
+  subset_search.py   bounded search for many-to-one groups
+  engine.py          a reconciliation run, start to finish
+  result.py          matches, breaks and run metadata
+  report.py          JSON and CSV output
+  cli.py             the `tieout` command
+  connectors/        one module per input format
+tests/               mirrors src/, plus fixtures/
+docs/adr/            architecture decisions
+examples/            runnable end-to-end examples
+```
+
+## Development
+
+```bash
+pip install uv
+uv sync
+uv run pytest
+uv run ruff check . && uv run ruff format --check . && uv run mypy
+```
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).