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.3.0.tar.gz (45.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.3.0-py3-none-any.whl (30.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: finlint_audit-0.3.0.tar.gz
  • Upload date:
  • Size: 45.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.3.0.tar.gz
Algorithm Hash digest
SHA256 eb7c2e291dcce3de6f315d13aa3c43a00a9c00e5d33146b982c9da5284cc947b
MD5 ba920074071221987f0559d4004fd658
BLAKE2b-256 b315b9b694e98011ab3ce4757e6e66818d5a53aca12b37bef12bd6c5adb6841d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: finlint_audit-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 30.8 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 561992a61d8dee16aade4ec8d4d8213a01533a7ac5d86b3c676bdcb57564ddd2
MD5 9052eaaaeb8d9a8f727cc8a01b80e99d
BLAKE2b-256 766ad548c0d0143fc552f856890ee52e255d4430687734ce897d787d39995259

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