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.5.0.tar.gz (57.6 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.5.0-py3-none-any.whl (34.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: finlint_audit-0.5.0.tar.gz
  • Upload date:
  • Size: 57.6 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.5.0.tar.gz
Algorithm Hash digest
SHA256 d5ef347ce5fc95c742eb1b7e976ef49df527823b7425638a7fd0bf3baf333b1c
MD5 c17db72aa8015bda2eabc119c6ec3d83
BLAKE2b-256 8d05b522edf771006f9b74cd7b8ef22e6c9d1f9a5326c9de048aad19768d2e89

See more details on using hashes here.

File details

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

File metadata

  • Download URL: finlint_audit-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 34.7 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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 167bfd00008cf54d8bd48c9ed187bb8a390192a68823e6bfb67ebf90bb6067c2
MD5 5b58e145515cf18b37ed24db65628827
BLAKE2b-256 b195df53185b66d993fcb88297c0a0726c0b2496aa1b69dfb529fd5a7cd6569a

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