min-fin

A minimalist on-budget personal finance tracker

setup

prerequisites

Ensure you have the following tools installed:

• uv - Fast Python package manager and project management
• git - Version control system
• Databricks CLI - Command-line interface for Databricks operations
• bruin - End-to-end Data Framework with Databricks connectivity
• make: - Build automation tool
• jq: - Lightweight, flexible command-line JSON processing

quick start

Set up a fully configured development environment by running:

make

Additional make commands are available for various tasks:

make validate             # Validate bruin pipeline and databricks asset bundle
make deploy               # Deploy bundle to databricks workspace
make destroy              # Destroy bundle resources on workspace
make run                  # Run bruin ingestion pipeline (and deploy resources if not already)
make gen-seed-lookup      # Generate CSV for institution lookup metadata (with some sample data)
make gen-seed-categories  # Generate CSV for transaction category regex patterns (with some sample data)

adding financial transactions

Use make gen-seed-lookup to generate a CSV of financial institution metadata. Place transaction CSV data from the relevant institution inside the subdirectory named after the institution_sub_path field. Then run make run to ingest that data via bruin into Databricks tables.

Other documentation TBD