Skip to main content

Financial data integrity assertions engine

Project description

finlint-audit

Financial data integrity assertions engine. Part of finlint.

Quick Start

from finlint_audit import (
    assert_net_worth,
    AssertionContext,
    Account,
    AccountType,
)
from decimal import Decimal

ctx = AssertionContext(
    accounts=[
        Account(id="1", type=AccountType.DEPOSITORY, balance_current=Decimal("10000")),
        Account(id="2", type=AccountType.CREDIT, balance_current=Decimal("2500")),
    ],
    holdings=[],
    liabilities=[],
    snapshots=[],
    transactions=[],
)
result = assert_net_worth(ctx)
print(result.status)  # "pass"
print(result.metadata["net_worth"])  # "7500"

CLI

pip install finlint-audit[all]
finlint-audit --config finlint.yaml
finlint-audit --config finlint.yaml --format json
finlint-audit --config finlint.yaml --dry-run

Built-in Assertions

ID Name What it checks
nw-001 Net Worth Equation assets + investments - liabilities = net_worth
sign-001 Sign Correctness Liabilities non-negative; no credit in asset totals
overlap-001 Overlap Detection No duplicate accounts across users
snap-001 Snapshot Consistency At most 1 snapshot/account/day; no gaps > N days
drift-001 Balance Drift Latest snapshot ≈ current balance

License

Apache-2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

finlint_audit-0.8.0.tar.gz (91.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

finlint_audit-0.8.0-py3-none-any.whl (64.2 kB view details)

Uploaded Python 3

File details

Details for the file finlint_audit-0.8.0.tar.gz.

File metadata

  • Download URL: finlint_audit-0.8.0.tar.gz
  • Upload date:
  • Size: 91.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for finlint_audit-0.8.0.tar.gz
Algorithm Hash digest
SHA256 25b16d430f9884f48a9096182e424f41e9a9847f0db4ef1c990362cb738a314b
MD5 a0be8a1670664e7849ca7a2462818e68
BLAKE2b-256 48c10d0405d6726a6f086ca3cf52551971d2df3e605bc13fe5fa50712f2037b6

See more details on using hashes here.

File details

Details for the file finlint_audit-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: finlint_audit-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 64.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for finlint_audit-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c4de8f0b1c1db5683b00ca679b25650f65c8905696ef092c022cd7ba76b1283e
MD5 5f60e450fd30d11f4627fc0a883d98f8
BLAKE2b-256 ea7820cc28822f98219db1f767e8a887fbb309652a4c4d19cb73900d3ab1b4b4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page