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
44 commits 1 branch 0 tags 1.1 MiB
Find a file
Viktor Barzin 1fac475ba2
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
Details
fire-planner: implementation plan — Reddit FIRE examples 
17 bite-sized TDD tasks (Task 1-17 + 11a follow-up):
  1   asyncpraw dependency
  2   alembic 0006_fire_examples migration
  3   FireExample ORM in db.py
  4   Pydantic schemas (RawPost / ExtractedExample / Summary)
  5   regex pre-filter (MONEY_RE + LOCATION_RE)
  6   async PRAW wrapper
  7   primary qwen3-8b extractor
  8   Tier 2 claude-agent-service fallback
  9   currency normalisation via fx.py
  10  service.upsert_example + summary_for_country
  11  orchestrator + click CLI ingest
  11a Prometheus follow-ups deferred + documented
  12  fixture-driven regression suite
  13  /api/examples + /summary router
  14  simulator response examples_overlay block
  15  Terraform K8s Job (toggled) + weekly CronJob
  16  build + push image
  17  run bulk ingest + smoke-test
2026-05-28 21:42:46 +00:00
alembic col: simulator auto-adjusts spending to local prices via Numbeo+Expatistan 2026-05-22 14:14:57 +00:00
docs/plans fire-planner: implementation plan — Reddit FIRE examples 2026-05-28 21:42:46 +00:00
fire_planner fire-planner: filterable date range on the home-page history chart 2026-05-28 09:04:58 +00:00
frontend fire-planner: filterable date range on the home-page history chart 2026-05-28 09:04:58 +00:00
tests fire-planner: filterable date range on the home-page history chart 2026-05-28 09:04:58 +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 fire-planner: copy frontend/.npmrc before npm ci in Dockerfile 2026-05-10 16:54:25 +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