Skip to main content

Financial compliance documentation linter. Accepts PDF, Word, Markdown. Vale rules + Python CLI for BSA/AML, SOX, PCI-DSS, GLBA, NCUA.

Project description

Comply — Financial Compliance Documentation Linter

The first open-source linting package for financial compliance documentation. Built on Vale.

The Problem

Credit unions and community banks maintain 200-500 compliance documents with 0-1 dedicated compliance staff. When regulators examine these documents, vague language, missing sections, inconsistent terminology, and outdated references are findings that lead to enforcement actions. No tool currently checks compliance documents for these issues before the examiner does.

What Comply Does

Comply is a Vale style package (FinCompliance) that catches compliance documentation issues deterministically:

  • Missing required elements — Does your BSA/AML policy address all five pillars?
  • Weak commitment language — "We will endeavor to comply" is not compliance
  • Vague regulatory references — "Per applicable regulations" fails examiner scrutiny
  • Prohibited phrases — "TBD", "under development", "budget permitting" in a compliance doc is a finding
  • Informal terminology — "customer info" instead of "customer information"
  • Inconsistent date formats — MM/DD/YY when your standard is YYYY-MM-DD
  • Abbreviation consistency — Expand on first use, abbreviate thereafter

Quick Start

# Install Vale
brew install vale  # macOS
# or: https://vale.sh/docs/vale-cli/installation/

# Clone this repo
git clone https://github.com/BipinRimal314/comply.git
cd comply

# Lint your compliance document
vale --config=.vale.ini path/to/your/bsa-policy.md

Supported Regulations

Regulation Rules Status
Common (cross-regulation) 11 rules Available
BSA/AML (Bank Secrecy Act / Anti-Money Laundering) 2 rules + CLI checks Available
SOX (Sarbanes-Oxley) 2 rules Available
PCI-DSS (Payment Card Industry) 2 rules Available
GLBA (Gramm-Leach-Bliley) 1 rule Available
NCUA (Credit Union specific) 1 rule Available

Example Output

tests/fail/weak-bsa-policy.md

 3:64   error    Risky language in BSA/AML document: 'when resources
                 permit'. Examiners interpret this as non-compliance.
 5:20   error    Risky language in BSA/AML document: 'under development'.
 5:42   error    Risky language in BSA/AML document: 'we plan to implement'.
 9:22   warning  Vague regulatory reference: 'per applicable regulations'.
                 Include specific section/part numbers.
 19:11  warning  Date format appears inconsistent. Use YYYY-MM-DD or
                 Month DD, YYYY consistently.

✖ 9 errors, 15 warnings and 2 suggestions in 1 file.

Architecture

Phase 1 (current): Pure Vale rules. Deterministic. No AI. No API keys. Runs offline.

Phase 2: CLI wrapper with document format conversion (PDF/Word → Markdown via MarkItDown).

Phase 3: AI augmentation via Claude API for substantive adequacy checks, cross-document consistency, and regulatory change impact analysis.

Phase 4: Regulatory change tracking. When a regulation updates, automatically identify which internal documents need revision.

Regulatory Requirements Library

regulatory-requirements/ contains machine-readable YAML definitions of regulatory requirements. This is the first open-source equivalent of NIST OSCAL for financial regulations. Currently covers BSA/AML (31 CFR Chapter X).

Contributing

We need help with:

  • Additional regulation rule packages (SOX, PCI-DSS, GLBA)
  • Testing against real compliance documents
  • Regulatory requirements YAML for additional frameworks
  • False positive reduction

License

MIT

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

fincompliance-0.2.0.tar.gz (50.4 kB view details)

Uploaded Source

Built Distribution

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

fincompliance-0.2.0-py3-none-any.whl (37.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fincompliance-0.2.0.tar.gz
  • Upload date:
  • Size: 50.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for fincompliance-0.2.0.tar.gz
Algorithm Hash digest
SHA256 e1dfbd086208a8c6687d3be797352d3010e13e1a858a89741100a6f0cc076dbe
MD5 9e3abd297a0a6b747d09b6a74bea21df
BLAKE2b-256 4ed291f9780b12d985267cedf9ddf00078f130b5ae5e8a150974e809820e9fc3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fincompliance-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 37.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for fincompliance-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e7f8d79cebe60a26d7dd7e05c6fc0b97c0a86109782dd1906b524f274a823c7f
MD5 e3ab0a6ea3b6d76e23889598f7f00dd1
BLAKE2b-256 a4626543d2978797a8438abe09913a3ba0313fc567b76e8e73a89c604be46791

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