statementproof 0.2.0__tar.gz → 0.2.2__tar.gz

{statementproof-0.2.0/statementproof.egg-info → statementproof-0.2.2}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: statementproof
-Version: 0.2.0
-Summary: Extract transactions from bank statement PDFs -- and prove the extraction is right, or say it isn't.
+Version: 0.2.2
+Summary: Convert bank statement PDFs to CSV for QuickBooks or Xero, then prove the conversion is right against the statement's own balances -- or say it isn't.
 License: MIT
 Project-URL: Homepage, https://github.com/OrbitalKeyAi/statementproof
 Project-URL: Documentation, https://orbitalkeyai.github.io/statementproof/
 Project-URL: Source, https://github.com/OrbitalKeyAi/statementproof
 Project-URL: Issues, https://github.com/OrbitalKeyAi/statementproof/issues
-Keywords: bank-statement,pdf,csv,bookkeeping,accounting,reconciliation,extraction,converter,quickbooks,xero
+Keywords: bank-statement,bank-statement-converter,pdf-to-csv,pdf-to-excel,statement-to-csv,quickbooks,xero,qbo,ofx,bookkeeping,accounting,reconciliation,audit-trail,extraction,converter,pdf,csv,finance,cli
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Financial and Insurance Industry
 Classifier: Topic :: Office/Business :: Financial :: Accounting
@@ -52,6 +52,9 @@ And when a row is misread:
     534.66 +37.07 should give 571.73, statement shows 497.59 (off by -74.14)
 ```
 
+**[See the actual output before installing →](https://orbitalkeyai.github.io/statementproof/demo.html)**
+Verified, silently-failing and batch runs, copied verbatim from real runs.
+
 ## Install
 
 ```bash

{statementproof-0.2.0 → statementproof-0.2.2}/pyproject.toml

@@ -4,14 +4,17 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "statementproof"
-version = "0.2.0"
-description = "Extract transactions from bank statement PDFs -- and prove the extraction is right, or say it isn't."
+version = "0.2.2"
+description = "Convert bank statement PDFs to CSV for QuickBooks or Xero, then prove the conversion is right against the statement's own balances -- or say it isn't."
 readme = "statementproof/README.md"
 requires-python = ">=3.9"
 license = { text = "MIT" }
 keywords = [
-    "bank-statement", "pdf", "csv", "bookkeeping", "accounting",
-    "reconciliation", "extraction", "converter", "quickbooks", "xero",
+    # The words a bookkeeper types, not the words we would use to describe the design.
+    "bank-statement", "bank-statement-converter", "pdf-to-csv", "pdf-to-excel",
+    "statement-to-csv", "quickbooks", "xero", "qbo", "ofx", "bookkeeping",
+    "accounting", "reconciliation", "audit-trail", "extraction", "converter",
+    "pdf", "csv", "finance", "cli",
 ]
 classifiers = [
     "Development Status :: 3 - Alpha",

{statementproof-0.2.0 → statementproof-0.2.2}/statementproof/README.md

@@ -27,6 +27,9 @@ And when a row is misread:
     534.66 +37.07 should give 571.73, statement shows 497.59 (off by -74.14)
 ```
 
+**[See the actual output before installing →](https://orbitalkeyai.github.io/statementproof/demo.html)**
+Verified, silently-failing and batch runs, copied verbatim from real runs.
+
 ## Install
 
 ```bash

{statementproof-0.2.0 → statementproof-0.2.2}/statementproof/__init__.py

@@ -1,2 +1,2 @@
 """statementproof - verifiable bank statement extraction."""
-__version__ = "0.2.0"
+__version__ = "0.2.2"

{statementproof-0.2.0 → statementproof-0.2.2}/statementproof/record.py

@@ -70,6 +70,27 @@ def licence_holder() -> str | None:
     return v or None
 
 
+_SCOPE = {
+    "VERIFIED":
+        "A VERIFIED verdict means the extracted transactions reproduce this statement's "
+        "own opening and closing balances. It does not certify that descriptions or dates "
+        "are correct, and it does not detect errors that leave the totals unchanged.",
+    "FAILED":
+        "A FAILED verdict means the extracted transactions do NOT reproduce this "
+        "statement's own balances. The findings above name where the running total stops "
+        "following. This record is evidence that the extraction was checked and did not "
+        "reconcile -- it is not evidence of an error in the statement itself.",
+    "UNVERIFIED":
+        "An UNVERIFIED verdict means this statement does not carry enough balance "
+        "information to check the extraction against. The extracted figures may be "
+        "correct; nothing here demonstrates that they are, so nothing is claimed.",
+}
+
+
+def _scope(verdict: str) -> str:
+    return _SCOPE.get(verdict, _SCOPE["UNVERIFIED"])
+
+
 def build(pdf_path: str, txns, res, opening, closing, diag=None, holder=None) -> dict:
     """One record for one statement. Pure data; rendering is separate."""
     now = dt.datetime.now(dt.timezone.utc)
@@ -103,18 +124,27 @@ def build(pdf_path: str, txns, res, opening, closing, diag=None, holder=None) ->
         "verification": {
             "verdict": res.verdict,
             "checks_run": list(res.checks_run),
+            # p.message, not str(p): Problem is a plain dataclass with no __str__, so
+            # str() yields its repr -- and the one document a firm files as evidence of
+            # review would have read `Problem(kind='chain_break', row=7, message=...)`.
+            # `where` mirrors validate.Result.report() so the record and the terminal
+            # describe the same finding the same way; an aggregate problem has no row
+            # and belongs to the statement as a whole.
             "problems": [
-                {"kind": p.kind, "row": getattr(p, "row", None), "detail": str(p)[:200]}
+                {"kind": p.kind,
+                 "row": p.row,
+                 "where": ("row %d" % p.row) if p.row is not None else "statement",
+                 "detail": p.message,
+                 "expected": fmt(p.expected_cents) if p.expected_cents is not None else None,
+                 "found": fmt(p.found_cents) if p.found_cents is not None else None}
                 for p in res.problems
             ],
         },
         # Said in the record itself, not only in the docs, because a record that
-        # overstates what it proves is worse than no record.
-        "scope_of_assurance":
-            "A VERIFIED verdict means the extracted transactions reproduce this "
-            "statement's own opening and closing balances. It does not certify that "
-            "descriptions or dates are correct, and it does not detect errors that "
-            "leave the totals unchanged.",
+        # overstates what it proves is worse than no record. The wording follows the
+        # verdict -- a FAILED record explaining what VERIFIED would have meant is
+        # answering a question nobody asked while leaving the real one unanswered.
+        "scope_of_assurance": _scope(res.verdict),
     }
 
 
@@ -198,10 +228,10 @@ def _one(rec: dict, heading: bool = True) -> str:
 
     probs = rec["verification"]["problems"]
     if probs:
-        L.append("<table><tr><th>Row</th><th>Finding</th></tr>")
+        L.append("<table><tr><th>Where</th><th>Finding</th></tr>")
         for p in probs[:40]:
             L.append("<tr><td>%s</td><td>%s</td></tr>"
-                     % (_e(p["row"] if p["row"] is not None else "-"), _e(p["detail"])))
+                     % (_e(p.get("where") or "statement"), _e(p["detail"])))
         L.append("</table>")
         if len(probs) > 40:
             L.append("<p class='sub'>… and %d more.</p>" % (len(probs) - 40))
@@ -255,7 +285,10 @@ def to_html(rec: dict) -> str:
 
         for r in rec["statements"]:
             L.append(_one(r))
-        scope = rec["statements"][0]["scope_of_assurance"] if rec["statements"] else ""
+        # Every verdict present in the batch, not just the first statement's -- a mixed
+        # batch whose first file happened to verify would otherwise print only the
+        # VERIFIED wording over a page that also contains failures.
+        scope = " ".join(_SCOPE[v] for v in sorted(s["by_verdict"]) if v in _SCOPE)
     else:
         L.append(_one(rec, heading=False))
         scope = rec["scope_of_assurance"]

{statementproof-0.2.0 → statementproof-0.2.2/statementproof.egg-info}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: statementproof
-Version: 0.2.0
-Summary: Extract transactions from bank statement PDFs -- and prove the extraction is right, or say it isn't.
+Version: 0.2.2
+Summary: Convert bank statement PDFs to CSV for QuickBooks or Xero, then prove the conversion is right against the statement's own balances -- or say it isn't.
 License: MIT
 Project-URL: Homepage, https://github.com/OrbitalKeyAi/statementproof
 Project-URL: Documentation, https://orbitalkeyai.github.io/statementproof/
 Project-URL: Source, https://github.com/OrbitalKeyAi/statementproof
 Project-URL: Issues, https://github.com/OrbitalKeyAi/statementproof/issues
-Keywords: bank-statement,pdf,csv,bookkeeping,accounting,reconciliation,extraction,converter,quickbooks,xero
+Keywords: bank-statement,bank-statement-converter,pdf-to-csv,pdf-to-excel,statement-to-csv,quickbooks,xero,qbo,ofx,bookkeeping,accounting,reconciliation,audit-trail,extraction,converter,pdf,csv,finance,cli
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Financial and Insurance Industry
 Classifier: Topic :: Office/Business :: Financial :: Accounting
@@ -52,6 +52,9 @@ And when a row is misread:
     534.66 +37.07 should give 571.73, statement shows 497.59 (off by -74.14)
 ```
 
+**[See the actual output before installing →](https://orbitalkeyai.github.io/statementproof/demo.html)**
+Verified, silently-failing and batch runs, copied verbatim from real runs.
+
 ## Install
 
 ```bash