Bank Statement Parser¶

Welcome to the documentation for bank_statement_parser — a Python library for parsing bank statement PDFs, extracting structured transaction data, and persisting results to Parquet files and a SQLite star-schema data mart.

Guides¶

• Adding a New Bank — step-by-step guide to creating configuration files for parsing statements from a new bank, including the TOML file structure, field extraction rules, and standard field mappings.
• Anonymisation — redacting personally identifiable information from statement PDFs, config setup, and output review.
• Project Structure — directory layout, SQLite schema, and Parquet file organisation.
• Export Options — simple vs. full export presets, CSV and Excel output.

Reference¶

• CLI Reference — all bsp process and bsp anonymise options with examples.
• Python API Reference — StatementBatch, report backends, export helpers, and database utilities.

Quick Links¶

• GitHub Repository
• PyPI Package
• Issue Tracker

About This Documentation¶

This site is built with Zensical, a modern static site generator compatible with the Material for MkDocs theme. Reference pages and guide sections are auto-generated from docstrings and comments in the source code using scripts/generate_docs.py, ensuring the documentation stays in sync with the codebase.