viktor/fire-planner
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Migrated from monorepo during Forgejo registry consolidation 2026-05-07
28 commits 1 branch 0 tags 807 KiB
Find a file
Viktor Barzin 3bfa46ad4f
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
Details
spending: prefill annual £ from actualbudget trailing 12mo 
Adds a thin read-only client for the actualbudget HTTP API
(`fire_planner/actualbudget.py`) and a `GET /spending/annual` endpoint
that returns trailing-N-month spending broken out by category group.

Default exclusions ("Investments and Savings", "Budget Reset") strip
out wealth transfers so the headline number reflects actual
consumption — for Viktor's data, ~£41k/yr instead of the raw £210k
total. Caller can pass `?exclude=...` to override.

Frontend uses the headline `total_gbp` to autofill the Annual spending
input (same pattern as nw_seed from networth), with a small
provenance line below the input showing the window + which groups
were excluded.

Auth: 3 new env vars (ACTUALBUDGET_API_URL/KEY/SYNC_ID) sourced from
Vault `secret/fire-planner` via the existing ExternalSecret —
infra/stacks/fire-planner applied separately. Backend silently keeps
the hardcoded default if the upstream is unreachable.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-10 11:11:51 +00:00
alembic schema: add life_event, retirement_goal; extend scenario with kind/parent 2026-05-09 21:36:58 +00:00
fire_planner spending: prefill annual £ from actualbudget trailing 12mo 2026-05-10 11:11:51 +00:00
frontend spending: prefill annual £ from actualbudget trailing 12mo 2026-05-10 11:11:51 +00:00
tests spending: prefill annual £ from actualbudget trailing 12mo 2026-05-10 11:11:51 +00:00
.dockerignore deploy: combined Dockerfile — FastAPI serves the SPA in prod 2026-05-09 22:25:52 +00:00
.gitignore Initial extraction from monorepo 2026-05-07 17:06:19 +00:00
.woodpecker.yml Phase 4: drop registry.viktorbarzin.me, Forgejo only 2026-05-07 23:17:46 +00:00
alembic.ini Initial extraction from monorepo 2026-05-07 17:06:19 +00:00
Dockerfile deploy: combined Dockerfile — FastAPI serves the SPA in prod 2026-05-09 22:25:52 +00:00
PLAYBOOK_VIKTOR.md Initial extraction from monorepo 2026-05-07 17:06:19 +00:00
poetry.lock Initial extraction from monorepo 2026-05-07 17:06:19 +00:00
pyproject.toml api: expand FastAPI surface for scenarios, networth, life-events, goals, simulate 2026-05-09 21:48:36 +00:00
README.md Initial extraction from monorepo 2026-05-07 17:06:19 +00:00

README.md

fire-planner

Risk-adjusted, tax-minimised FIRE retirement planner. Consumes today's portfolio, savings rate, and RSU vest schedule from sibling services (wealthfolio, payslip-ingest, hmrc-sync) and returns the after-tax probability of success for each combination of jurisdiction, withdrawal strategy, and "year you break UK tax residency".

Layout

  • fire_planner/ — package
    • tax/ — per-jurisdiction tax engines (UK, nomad, Malaysia, Thailand, Cyprus, Bulgaria)
    • returns/ — Shiller 1871+ data + block bootstrap sampler
    • strategies/ — Trinity 4% SWR, Guyton-Klinger guardrails, VPW
    • ingest/ — pulls from wealthfolio / payslip-ingest / hmrc-sync
    • simulator.py — vectorised NumPy MC engine
    • scenarios.py — Cartesian product over (jurisdiction × strategy × leave-UK-year × glide)
    • app.py — FastAPI on-demand /recompute
    • __main__.py — click CLI: ingest, simulate, recompute-all, migrate

Common commands

poetry install
pytest -v
mypy .
ruff check .
yapf --recursive .

# Run migrations against the local DB:
DB_CONNECTION_STRING=postgresql+asyncpg://... alembic upgrade head

# CLI
DB_CONNECTION_STRING=... python -m fire_planner ingest
DB_CONNECTION_STRING=... python -m fire_planner simulate --scenario=cyprus-vpw-leave-y3
DB_CONNECTION_STRING=... python -m fire_planner recompute-all

Schema

Six tables in fire_planner schema on pg-cluster-rw:

  • account_snapshot — daily NW per account (Wealthfolio)
  • scenario — Cartesian-product scenario definition
  • mc_run — execution metadata + summary stats per (scenario, run_at)
  • mc_path — sparse storage (top decile, bottom decile, median)
  • projection_yearly — deterministic point projection per scenario
  • scenario_summary — denormalised fast-read for Grafana