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.2.0.tar.gz (31.0 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.2.0-py3-none-any.whl (21.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: finlint_audit-0.2.0.tar.gz
  • Upload date:
  • Size: 31.0 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.2.0.tar.gz
Algorithm Hash digest
SHA256 b0c64938c025e2858aa27991fedbc1bfa7574f69591b6a74c3f521b1d890d1f7
MD5 d8ea223ad3a4f19681995fb4823cb358
BLAKE2b-256 4303847fa34c7a7fe1ca1cd243a3e1e7f3a29279a26b3df9a859126c2a2410c8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: finlint_audit-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 21.6 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 20427fe47d94917e0bd4a828b14b8d7953ea5e3ed3ec810a342dbaeb4be4e3fa
MD5 14a0be5bd1bedf5beff7f3de36e955cd
BLAKE2b-256 c980c4fe0f901c330a3c8eb9efac148572071d496ba4cfa29e9f0c80dad5af9c

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