financial_planner 0.1.0__tar.gz

financial_planner-0.1.0/.gitignore

@@ -0,0 +1,24 @@
+# environments
+.pixi/
+__pycache__/
+*.pyc
+.pytest_cache/
+*.egg-info/
+dist/
+build/
+
+# frontend
+web/node_modules/
+
+# app state written next to a plan (planner edits, scenarios)
+.financial_planner/
+
+# never commit real financial data: only the fake demo data is tracked
+*.csv
+!examples/demo/data/*.csv
+!tests/fixtures/*.csv
+
+.DS_Store
+
+# desktop app builds
+installer/dist/

financial_planner-0.1.0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, brookie
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

financial_planner-0.1.0/LLM_SETUP.md

@@ -0,0 +1,109 @@
+# Setting up a plan with an AI assistant
+
+These are instructions for an AI coding assistant (one that can read files and run commands) to set
+up a Financial Planner plan with a person. To use them, open a terminal in your plan folder, start
+your assistant, and say:
+
+> Read `<path to financial_planner>/LLM_SETUP.md` and help me set up my financial plan in this
+> folder.
+
+**Before you start:** the assistant will read your bank exports and what you tell it. Only use an
+assistant and account you trust with financial data, and review what it writes.
+
+---
+
+## Instructions for the assistant
+
+You are helping a person build a plan for the Financial Planner app. Follow these steps in order.
+Ask one small group of questions at a time, explain briefly why you're asking, accept "skip" or "I
+don't know" (use the defaults), and confirm before writing files.
+
+### 0. Privacy rules (always)
+
+- Use generic names in the config: "Partner A", "Partner B", "Child 1". If the person gives real
+  names, suggest generic ones and use those unless they insist.
+- Never write birthdates (ages only), account numbers, addresses, employer names or Social Security
+  numbers into the config. Generic labels like "Employer A pension" are fine.
+- Keep the plan folder outside any public repository. If the folder is inside a git repository,
+  warn the person and suggest adding `data/` and `.financial_planner/` to `.gitignore` (or not
+  committing the plan at all).
+- Don't upload, paste or send the person's data anywhere other than the files in the plan folder.
+- If CSV descriptions contain card or account numbers, point that out.
+
+### 1. Create the plan folder
+
+If `config/` doesn't exist in the working folder, run:
+
+```bash
+financial_plan init .
+```
+
+(or `pixi run financial_plan init .` / `python -m financial_planner init .`, whichever works). This
+writes `config/config.yaml`, `sources.yaml`, `categories.yaml` and `rules.yaml` with comments.
+Every field is documented in the wiki's Config Reference
+(https://github.com/brookisme/financial_planner/wiki/Config-Reference); the other wiki pages
+(Data Sources, Categories, Categorizing and Rules) explain each part in detail.
+
+### 2. Household (`config/config.yaml` › `household`)
+
+Ask, for each adult (one or more):
+- age; take-home (net) pay per month and where it came from (pay stub, average of recent months);
+- expected yearly raise above inflation (default 0);
+- Social Security estimate at 67 (from their statement; a rough guess is fine) and when they plan
+  to claim (default: when retiring);
+- pensions: name, monthly estimates by retirement age if they have them (e.g. from a pension
+  estimate tool), years of service so far;
+- retirement accounts (401k, 403b, IRA): name, balance, monthly contribution.
+
+The first partner is the "primary": the retirement-age slider is their age. Ask what age they're
+thinking of retiring at (`assumptions.retirement.default_age`).
+
+For each child: age, 529 balance and monthly contribution, the kind of college to plan for
+(`public`, `flagship`, `private`, or custom schools under `assumptions.college.schools`), and the
+graduation month if they know it.
+
+### 3. Savings, investments, assumptions
+
+- Other monthly income; monthly transfers to savings (`savings`); brokerage / stock accounts
+  (`investments`: balance, a return % or 0 to leave it off, monthly additions).
+- Retirement assumptions: health insurance cost after retiring, tax rate in retirement (10-15% is a
+  common rough figure). Keep the default return / inflation unless they have a view.
+
+### 4. Data sources (`config/sources.yaml`)
+
+1. List the CSVs in `data/`. If there are none, ask the person to export 12 months of transactions
+   from each bank and card website as CSV and save them in `data/`.
+2. For each distinct export layout run `financial_plan inspect-csv data/<file>.csv --name "<label>"`.
+   It prints the columns, sample rows and a suggested source entry.
+3. Check the suggestion against the sample: the date column, the description column(s), and the
+   amount sign. Internally money out must be positive. For one signed column, set
+   `outflow: negative` if purchases are negative in the file, `positive` if purchases are positive.
+   For separate columns use `amount: {debit: <out column>, credit: <in column>}`.
+4. Use a glob in `files` (e.g. `data/visa*.csv`) so future exports are picked up.
+5. Run `financial_plan validate .` and fix any problems it reports.
+
+### 5. Categories and rules (`categories.yaml`, `rules.yaml`)
+
+1. Start from the starter categories. Ask whether to add or rename any (e.g. Coffee, Pets,
+   Childcare). Mark transfers, card payments, paychecks and savings/529 transfers as
+   `kind: ignore`; irregular big costs (property tax, a one-off purchase) as `kind: one_time`;
+   money coming in that offsets spending (reimbursements, refunds) as `kind: credit`.
+2. Run `financial_plan categorize . --unmatched` to see what no rule catches.
+3. Propose rules in small batches, grouped by merchant: prefer `contains` on a distinctive word,
+   `matches` for several merchants (`'COFFEE|CAFE'`), `similar_to` for merchants with changing
+   store numbers, `field: category` + `equals` to reuse the bank's own category, and filters
+   (`direction`, `min_amount`) when a word is ambiguous. Show the person the batch, then write it.
+   Put specific rules above general ones (first match wins).
+4. Ask about anything you can't tell (Venmo, checks, cash, ambiguous merchants). Don't guess
+   silently.
+5. Repeat until the unmatched list is short and the averages from `financial_plan categorize .`
+   look right to the person.
+
+### 6. Finish
+
+1. Run `financial_plan validate .` once more.
+2. Start the app with `financial_plan start .` and suggest they look at the planner strip, then
+   Settings › Categorize to fix any remaining rows by clicking them.
+3. Offer `financial_plan launcher` to put a double-click shortcut on their desktop.
+4. Remind them: the plan folder holds private data; keep it off the internet and out of public
+   repositories.

financial_planner-0.1.0/PKG-INFO

@@ -0,0 +1,125 @@
+Metadata-Version: 2.5
+Name: financial-planner
+Version: 0.1.0
+Summary: A local, private household budget and long-term financial planner driven by CSVs and YAML.
+Project-URL: Homepage, https://github.com/brookisme/financial_planner
+Project-URL: Documentation, https://github.com/brookisme/financial_planner/wiki
+Project-URL: Issues, https://github.com/brookisme/financial_planner/issues
+Author: Brookie Guzder-Williams
+License: BSD-3-Clause
+License-File: LICENSE
+Keywords: 529,budget,household,personal finance,planner,retirement
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Financial
+Requires-Python: >=3.11
+Requires-Dist: fastapi>=0.110
+Requires-Dist: pydantic>=2.6
+Requires-Dist: ruamel-yaml>=0.18
+Requires-Dist: uvicorn>=0.29
+Provides-Extra: desktop
+Requires-Dist: pillow>=10; extra == 'desktop'
+Requires-Dist: pystray>=0.19; extra == 'desktop'
+Provides-Extra: dev
+Requires-Dist: httpx>=0.27; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<sub>🤖 <b>Built with Claude.</b> This project was developed heavily with <a href="https://www.anthropic.com/claude">Claude</a> (Anthropic's AI assistant) using Claude Code.</sub>
+
+# Financial Planner
+
+A private, local household budget and long-term planner. Point it at the CSV exports from your bank
+and credit cards, describe your household (in the app or in YAML), and explore your monthly budget,
+college savings, retirement and how spending changes over time.
+
+**Full documentation: [the wiki](https://github.com/brookisme/financial_planner/wiki).**
+
+<p align="center"><img src="https://raw.githubusercontent.com/brookisme/financial_planner/main/assets/app-overview.png" height="350" alt="The Financial Planner app, showing the monthly planner and the retirement section with fictional demo data"></p>
+
+## Contents
+
+- [Features](#features)
+- [Privacy first](#privacy-first)
+- [Quick start](#quick-start)
+- [Your own plan](#your-own-plan)
+- [Commands](#commands)
+- [Development](#development)
+- [License](#license)
+
+## Features
+
+- **Monthly planner**: every category at its average; change any number and see what's left over.
+- **Explore spending**: monthly charts, top merchants and every transaction.
+- **College 529s**: a projection for each child against the cost of college.
+- **Retirement**: income at each retirement age from pensions, accounts, investments and Social Security.
+- **Spending over time**: how costs change as children leave home and after retiring.
+- **Scenarios**: save, compare and share what-ifs, or share the whole plan as one file.
+- **Settings and categorizing in the app**: no YAML editing required (but it's there if you want it).
+
+## Privacy first
+
+Everything runs on your computer and nothing is uploaded. Your plan folder holds real financial
+data: **keep it out of public repositories and off the internet**, and use generic names (Partner A,
+Child 1). See [Privacy and Safety](https://github.com/brookisme/financial_planner/wiki/Privacy-and-Safety).
+
+## Quick start
+
+Install [pixi](https://pixi.sh), then:
+
+```bash
+git clone https://github.com/brookisme/financial_planner.git
+cd financial_planner
+pixi run demo
+```
+
+Your browser opens at http://127.0.0.1:8765 with a fictional demo household.
+
+## Your own plan
+
+```bash
+pixi run financial_plan init ~/MyFinancialPlan    # create a plan folder
+pixi run financial_plan start ~/MyFinancialPlan   # open it
+```
+
+Put your bank and card CSV exports in `~/MyFinancialPlan/data/`, then click the **gear (Settings)**
+at the top right to add your household, connect the CSVs and categorize. On a Mac,
+`pixi run financial_plan launcher` adds a **Financial Planner** app to Applications (menu-bar icon,
+opens in the browser). A no-code download is described in the
+[Desktop App](https://github.com/brookisme/financial_planner/wiki/Desktop-App) page.
+
+Step-by-step guide: [Quick Start](https://github.com/brookisme/financial_planner/wiki/Quick-Start).
+Want an AI assistant to set it up with you? See [LLM_SETUP.md](https://github.com/brookisme/financial_planner/blob/main/LLM_SETUP.md).
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `financial_plan init [dir] [--demo]` | Create a plan folder (blank, or a copy of the demo). |
+| `financial_plan start [dir]` | Open the app. |
+| `financial_plan validate [dir]` | Check the config and CSVs. |
+| `financial_plan inspect-csv FILE` | Show a CSV's columns and a suggested source entry. |
+| `financial_plan export [dir]` / `import FILE` | Share a whole plan (config + data) as one .zip. |
+| `financial_plan categorize [dir] [--unmatched]` | Category averages; rows no rule caught. |
+| `financial_plan launcher` | Mac: add Financial Planner.app to /Applications. Elsewhere: a desktop shortcut. |
+
+Details: [Command Line](https://github.com/brookisme/financial_planner/wiki/Command-Line).
+
+## Development
+
+```bash
+pixi run -e dev test-all     # Python + forecast-math tests
+pixi run -e dev web-build    # rebuild the web app
+```
+
+See [Development](https://github.com/brookisme/financial_planner/wiki/Development).
+
+## License
+
+BSD 3-Clause. Not financial advice: projections are rough and depend on the assumptions you enter.

financial_planner-0.1.0/README.md

@@ -0,0 +1,92 @@
+<sub>🤖 <b>Built with Claude.</b> This project was developed heavily with <a href="https://www.anthropic.com/claude">Claude</a> (Anthropic's AI assistant) using Claude Code.</sub>
+
+# Financial Planner
+
+A private, local household budget and long-term planner. Point it at the CSV exports from your bank
+and credit cards, describe your household (in the app or in YAML), and explore your monthly budget,
+college savings, retirement and how spending changes over time.
+
+**Full documentation: [the wiki](https://github.com/brookisme/financial_planner/wiki).**
+
+<p align="center"><img src="https://raw.githubusercontent.com/brookisme/financial_planner/main/assets/app-overview.png" height="350" alt="The Financial Planner app, showing the monthly planner and the retirement section with fictional demo data"></p>
+
+## Contents
+
+- [Features](#features)
+- [Privacy first](#privacy-first)
+- [Quick start](#quick-start)
+- [Your own plan](#your-own-plan)
+- [Commands](#commands)
+- [Development](#development)
+- [License](#license)
+
+## Features
+
+- **Monthly planner**: every category at its average; change any number and see what's left over.
+- **Explore spending**: monthly charts, top merchants and every transaction.
+- **College 529s**: a projection for each child against the cost of college.
+- **Retirement**: income at each retirement age from pensions, accounts, investments and Social Security.
+- **Spending over time**: how costs change as children leave home and after retiring.
+- **Scenarios**: save, compare and share what-ifs, or share the whole plan as one file.
+- **Settings and categorizing in the app**: no YAML editing required (but it's there if you want it).
+
+## Privacy first
+
+Everything runs on your computer and nothing is uploaded. Your plan folder holds real financial
+data: **keep it out of public repositories and off the internet**, and use generic names (Partner A,
+Child 1). See [Privacy and Safety](https://github.com/brookisme/financial_planner/wiki/Privacy-and-Safety).
+
+## Quick start
+
+Install [pixi](https://pixi.sh), then:
+
+```bash
+git clone https://github.com/brookisme/financial_planner.git
+cd financial_planner
+pixi run demo
+```
+
+Your browser opens at http://127.0.0.1:8765 with a fictional demo household.
+
+## Your own plan
+
+```bash
+pixi run financial_plan init ~/MyFinancialPlan    # create a plan folder
+pixi run financial_plan start ~/MyFinancialPlan   # open it
+```
+
+Put your bank and card CSV exports in `~/MyFinancialPlan/data/`, then click the **gear (Settings)**
+at the top right to add your household, connect the CSVs and categorize. On a Mac,
+`pixi run financial_plan launcher` adds a **Financial Planner** app to Applications (menu-bar icon,
+opens in the browser). A no-code download is described in the
+[Desktop App](https://github.com/brookisme/financial_planner/wiki/Desktop-App) page.
+
+Step-by-step guide: [Quick Start](https://github.com/brookisme/financial_planner/wiki/Quick-Start).
+Want an AI assistant to set it up with you? See [LLM_SETUP.md](https://github.com/brookisme/financial_planner/blob/main/LLM_SETUP.md).
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `financial_plan init [dir] [--demo]` | Create a plan folder (blank, or a copy of the demo). |
+| `financial_plan start [dir]` | Open the app. |
+| `financial_plan validate [dir]` | Check the config and CSVs. |
+| `financial_plan inspect-csv FILE` | Show a CSV's columns and a suggested source entry. |
+| `financial_plan export [dir]` / `import FILE` | Share a whole plan (config + data) as one .zip. |
+| `financial_plan categorize [dir] [--unmatched]` | Category averages; rows no rule caught. |
+| `financial_plan launcher` | Mac: add Financial Planner.app to /Applications. Elsewhere: a desktop shortcut. |
+
+Details: [Command Line](https://github.com/brookisme/financial_planner/wiki/Command-Line).
+
+## Development
+
+```bash
+pixi run -e dev test-all     # Python + forecast-math tests
+pixi run -e dev web-build    # rebuild the web app
+```
+
+See [Development](https://github.com/brookisme/financial_planner/wiki/Development).
+
+## License
+
+BSD 3-Clause. Not financial advice: projections are rough and depend on the assumptions you enter.

financial_planner-0.1.0/examples/demo/config/categories.yaml

@@ -0,0 +1,65 @@
+# kind: spending (regular, averaged) | one_time (kept out of averages, optional toggle)
+#       credit (money in that can offset spending) | ignore (transfers, payments, paychecks)
+# kids_gone_pct / retired_pct: how the category changes once the kids leave / after retiring.
+
+categories:
+  # Essentials
+  - {name: Housing, group: Essentials}
+  - {name: Utilities, group: Essentials, kids_gone_pct: -15}
+  - {name: Groceries, group: Essentials, kids_gone_pct: -35}
+  - {name: Kids' school, group: Essentials, kids_gone_pct: -100}
+  - {name: Kids' activities, group: Essentials, kids_gone_pct: -100}
+  - {name: Health & Wellness, group: Essentials, kids_gone_pct: -15, retired_pct: 20}
+  - {name: Insurance, group: Essentials, retired_pct: -50}
+  - {name: Transportation, group: Essentials, kids_gone_pct: -15, retired_pct: -20}
+  - {name: Pets, group: Essentials}
+  # Flexible ("try 10% less" trims these)
+  - {name: Shopping & Household, group: Flexible, flexible: true, kids_gone_pct: -30}
+  - {name: Dining, group: Flexible, flexible: true, kids_gone_pct: -25}
+  - {name: Coffee, group: Flexible, flexible: true}
+  - {name: Travel, group: Flexible, flexible: true, kids_gone_pct: -15, retired_pct: 25}
+  - {name: Entertainment, group: Flexible, flexible: true, kids_gone_pct: -20, retired_pct: 10}
+  - {name: Subscriptions & Phone, group: Flexible, flexible: true, kids_gone_pct: -15}
+  # Unsorted
+  - {name: Venmo, group: Unsorted, kids_gone_pct: -30}
+  - {name: Cash & checks, group: Unsorted, kids_gone_pct: -30}
+  - {name: Other, group: Unsorted, kids_gone_pct: -20}
+
+  # One-time / yearly costs: shown as toggles under "Yearly and one-time costs"
+  - name: Income tax
+    kind: one_time
+    tax: true
+    default_on: true
+    label: Set aside for income tax
+    note: state payment
+  - name: Property tax
+    kind: one_time
+    tax: true
+    in_retirement: true
+    label: Set aside for property tax
+  - name: Furniture
+    kind: one_time
+    label: Include furniture / large household purchases
+    note: may come up again
+
+  # Credits (money in)
+  - name: Benefit reimbursements
+    kind: credit
+    default_on: true
+    offsets: Shopping & Household     # shown as a line under Shopping & Household
+    label: Reimbursements
+    note: work benefit payments
+  - name: Federal tax refund
+    kind: credit
+    default_on: true
+    offsets: Income tax               # nested under the income tax toggle
+    label: Subtract the federal refund
+  - name: Other credits
+    kind: credit
+    label: Other reimbursements & credits
+    note: mobile deposits and other money in
+
+  # Never counted
+  - {name: Paychecks, kind: ignore}
+  - {name: Transfers & payments, kind: ignore}
+  - {name: 529 contributions, kind: ignore}

financial_planner-0.1.0/examples/demo/config/config.yaml

@@ -0,0 +1,82 @@
+# Demo plan: an entirely fictional household. Copy this folder to start your own plan, or run
+# `financial_plan init my_plan` for a blank one.
+
+plan:
+  title: Household Budget
+  subtitle: A fictional two-partner household with two kids, built from a demo card and checking account.
+  months: 12          # average over the last 12 months of transactions
+  # today: 2026-01    # the plan's "now"; defaults to the month after the last transaction
+
+household:
+  partners:
+    - id: alex
+      name: Alex
+      age: 46
+      take_home_monthly: 7220.84
+      take_home_note: two paychecks a month
+      raise_pct: 0
+      social_security:
+        at_67: 3100
+      pensions:
+        - name: Robotics pension
+          estimates: {55: 800, 60: 1900, 65: 3400}
+          service_years_now: 9
+      accounts:
+        - name: Old 401(k)
+          balance: 148000
+          monthly: 0
+    - id: jordan
+      name: Jordan
+      age: 44
+      take_home_monthly: 4120
+      take_home_note: clinic paycheck
+      social_security:
+        at_67: 2400
+        claim_age: 67
+      accounts:
+        - name: 403(b)
+          balance: 61000
+          monthly: 600
+  children:
+    - id: riley
+      name: Riley
+      age: 12
+      college_529: {balance: 38500, monthly: 500}
+      school: flagship
+    - id: casey
+      name: Casey
+      age: 7
+      college_529: {balance: 12400, monthly: 500}
+      school: flagship
+
+other_income_monthly: 0
+
+savings:
+  - id: emergency
+    name: Emergency savings
+    monthly: 500
+
+investments:
+  - id: brokerage
+    name: Brokerage
+    balance: 22000
+    return_pct: 0      # 0 = off until you pick a rate
+    monthly: 0
+
+assumptions:
+  retirement:
+    return_pct: 5.5
+    inflation_pct: 3
+    withdrawal_pct: 4
+    tax_pct: 12
+    health_insurance_monthly: 1100
+    default_age: 63
+  college:
+    schools:
+      public: {name: Public in-state, cost: 30000}
+      flagship: {name: Flagship in-state, cost: 42000}
+      private: {name: Private, cost: 68000}
+    default_preset: mid
+
+default_category: Other
+default_credit_category: Other credits

financial_planner-0.1.0/examples/demo/config/rules.yaml

@@ -0,0 +1,33 @@
+# Categorization rules. Row rules ("this row is X") always win; otherwise the first match wins.
+# One condition per rule: row | equals | contains | matches (regex) | similar_to
+# field: description (default), category (the bank's), source, any CSV column, or "*" for any.
+# Optional filters: source, direction (debit|credit), min_amount, max_amount.
+
+rules:
+  # never counted
+  - {category: Paychecks, contains: PAYROLL}
+  - {category: Transfers & payments, matches: 'PAYMENT THANK YOU|CARD PAYMENT|TRANSFER TO SAVINGS'}
+  - {category: 529 contributions, contains: COLLEGEPLAN 529}
+
+  # credits
+  - {category: Benefit reimbursements, contains: BENEFITS REIMBURSEMENT}
+  - {category: Federal tax refund, contains: IRS TREAS}
+
+  # one-time
+  - {category: Property tax, contains: COUNTY TAX COLLECTOR}
+  - {category: Income tax, contains: STATE TAX BOARD}
+  - {category: Furniture, contains: FURNITURE, min_amount: 500}
+
+  # spending
+  - {category: Housing, contains: MORTGAGE}
+  - {category: Utilities, contains: POWER & WATER}
+  - {category: Coffee, matches: 'COFFEE|CAFE|ESPRESSO'}
+  - {category: Groceries, matches: 'FRESH FIELDS|CORNER GROCER'}
+  - {category: Kids' school, contains: TUITION}
+  - {category: Kids' activities, matches: 'CAMP\b|DANCERS|TOY CASTLE'}
+  - {category: Pets, similar_to: PAWS & CLAWS PET SUPPLY}
+  - {category: Health & Wellness, contains: GYM}
+  - {category: Insurance, contains: INSURANCE}
+  - {category: Venmo, contains: VENMO}
+  - {category: Cash & checks, matches: '^ATM|^CHECK \d+'}
+  - {category: Other credits, contains: MOBILE DEPOSIT}

financial_planner-0.1.0/examples/demo/config/sources.yaml

@@ -0,0 +1,25 @@
+# Each source is one kind of CSV export. Column names are whatever your bank uses.
+
+sources:
+  - name: Northwind card
+    files: data/northwind_card_*.csv
+    date: {column: Transaction Date}          # format is detected (here 2025-01-31)
+    description: Description
+    amount: {debit: Debit, credit: Credit}    # separate money-out / money-in columns
+    category_column: Category                 # the card's own category, usable in rules
+    category_map:                             # card category -> plan category (when no rule matches)
+      Dining: Dining
+      Gas/Automotive: Transportation
+      Health Care: Health & Wellness
+      Entertainment: Entertainment
+      Airfare: Travel
+      Lodging: Travel
+      Other Travel: Transportation
+      Phone/Cable: Subscriptions & Phone
+      Merchandise: Shopping & Household
+
+  - name: Harbor checking
+    files: data/harbor_checking_*.csv
+    date: {column: Posting Date, format: '%m/%d/%Y'}
+    description: [Description, Memo]          # several columns are joined with a space
+    amount: {column: Amount, outflow: negative}   # one signed column; withdrawals are negative