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.1.0.tar.gz (24.7 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.1.0-py3-none-any.whl (18.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: finlint_audit-0.1.0.tar.gz
  • Upload date:
  • Size: 24.7 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.1.0.tar.gz
Algorithm Hash digest
SHA256 e2678e5953a1ebfc79636099299d935a3f3616c5d7d67341e092421fd980fd74
MD5 0f6ad68e0864e0dd13caecc78cb385fb
BLAKE2b-256 766c5dbd497aeb00a3d6b96083d9ce56dc60225798847eddd2a97aed1180ffee

See more details on using hashes here.

File details

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

File metadata

  • Download URL: finlint_audit-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 18.1 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f8d8df8df25d6816b3c978f42792264d92e753d0d14a0855f89d9508ab2b4bfe
MD5 10abf4ec67fabba8bd8bf71b2a4f5d16
BLAKE2b-256 a4a5404483b9301f789abab2e0163f5df2152bdcfdb43719bacbf90805662966

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