glidepath 0.3.0__tar.gz → 0.5.0__tar.gz

{glidepath-0.3.0 → glidepath-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: glidepath
-Version: 0.3.0
+Version: 0.5.0
 Summary: Desktop retirement and investment planner (UK-first, region-extensible).
 Keywords: retirement,pension,financial-planning,investment,uk,sipp,isa,monte-carlo
 Author: James Williams
@@ -59,7 +59,7 @@ nothing is transmitted.
 
 *(All screenshots show example data, not anyone's real finances.)*
 
-What it models today (single person, UK):
+What it models today (UK, single or couple):
 
 - **Wrappers** — workplace DC, SIPP, S&S ISA, LISA, GIA and cash, with
   UK contribution relief mechanics and dividend/savings taxation.
@@ -69,6 +69,14 @@ What it models today (single person, UK):
   including deferral.
 - **Tax** — rUK and Scottish income tax from verified 2026/27 data
   files; pension allowances (AA/taper/MPAA, lump-sum allowance).
+- **Couples** — an optional partner, modelled end to end: one pooled
+  household decumulation drawing tax-efficiently across both partners'
+  wrappers with each person taxed individually (mixed rUK/Scottish
+  residency included), the marriage allowance claimed when eligible,
+  optional survivor modelling ("model death at age" — pensions pass as
+  beneficiary drawdown, ISAs via the additional permitted
+  subscription, DB schemes at their survivor fraction), and joint-life
+  annuities paying a 50/66/100% survivor income.
 - **Projection** — deterministic or Monte Carlo runs from the app:
   success rate, probability of ruin, ending-pot percentiles, and a
   probability fan chart on its own tab, reproducible from a seed. With
@@ -193,8 +201,11 @@ Releases are `vX.Y.Z` tags on `main`. Each one is published to
 trusted publishing with PEP 740 attestations, and as a GitHub Release
 carrying its notes from
 [`CHANGELOG.md`](https://github.com/williajm/glidepath/blob/main/CHANGELOG.md)
-with the same artifacts attached. There are no packaged binary builds
-(installer/exe) yet — install from PyPI as above.
+with the same artifacts attached, each carrying signed build
+provenance — verify a downloaded file with
+`gh attestation verify <file> -R williajm/glidepath`. There are no
+packaged binary builds (installer/exe) yet — install from PyPI as
+above.
 
 ## Data licences
 

{glidepath-0.3.0 → glidepath-0.5.0}/README.md

@@ -31,7 +31,7 @@ nothing is transmitted.
 
 *(All screenshots show example data, not anyone's real finances.)*
 
-What it models today (single person, UK):
+What it models today (UK, single or couple):
 
 - **Wrappers** — workplace DC, SIPP, S&S ISA, LISA, GIA and cash, with
   UK contribution relief mechanics and dividend/savings taxation.
@@ -41,6 +41,14 @@ What it models today (single person, UK):
   including deferral.
 - **Tax** — rUK and Scottish income tax from verified 2026/27 data
   files; pension allowances (AA/taper/MPAA, lump-sum allowance).
+- **Couples** — an optional partner, modelled end to end: one pooled
+  household decumulation drawing tax-efficiently across both partners'
+  wrappers with each person taxed individually (mixed rUK/Scottish
+  residency included), the marriage allowance claimed when eligible,
+  optional survivor modelling ("model death at age" — pensions pass as
+  beneficiary drawdown, ISAs via the additional permitted
+  subscription, DB schemes at their survivor fraction), and joint-life
+  annuities paying a 50/66/100% survivor income.
 - **Projection** — deterministic or Monte Carlo runs from the app:
   success rate, probability of ruin, ending-pot percentiles, and a
   probability fan chart on its own tab, reproducible from a seed. With
@@ -165,8 +173,11 @@ Releases are `vX.Y.Z` tags on `main`. Each one is published to
 trusted publishing with PEP 740 attestations, and as a GitHub Release
 carrying its notes from
 [`CHANGELOG.md`](https://github.com/williajm/glidepath/blob/main/CHANGELOG.md)
-with the same artifacts attached. There are no packaged binary builds
-(installer/exe) yet — install from PyPI as above.
+with the same artifacts attached, each carrying signed build
+provenance — verify a downloaded file with
+`gh attestation verify <file> -R williajm/glidepath`. There are no
+packaged binary builds (installer/exe) yet — install from PyPI as
+above.
 
 ## Data licences
 

{glidepath-0.3.0 → glidepath-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "glidepath"
-version = "0.3.0"
+version = "0.5.0"
 description = "Desktop retirement and investment planner (UK-first, region-extensible)."
 readme = "README.md"
 # MIT code plus one CC BY-NC-SA 4.0 data file (returns_history.toml —
@@ -61,6 +61,7 @@ dev = [
     "pre-commit",
     "pytest",
     "pytest-cov",
+    "pytest-qt",
     "pytest-timeout",
     "ruff",
 ]
@@ -73,7 +74,7 @@ build-backend = "uv_build"
 [tool.uv]
 # Supply-chain cooldown: resolution ignores anything published to PyPI after
 # this timestamp (now minus 7 days). Updated ONLY by `make deps`.
-exclude-newer = "2026-08-01T17:09:10Z"
+exclude-newer = "2026-08-06T18:44:36Z"
 
 # PyPI is the ONLY permitted index (supply-chain policy; see CLAUDE.md).
 [[tool.uv.index]]
@@ -153,6 +154,9 @@ pythonpath = ["scripts", "tests"]
 # GUI suite waits on worker pools for up to 60s, so the ceiling sits
 # safely above that while still cutting a wedged run short.
 timeout = 120
+# pytest-qt would autodetect PySide6 anyway; pinning the binding keeps the
+# plugin from ever picking up a stray PyQt installed into the venv.
+qt_api = "pyside6"
 markers = [
     "gui: exercises the PySide6 shell on the offscreen Qt platform",
     "slow: long-running engine sweeps (Monte Carlo, backtest, solvers); deselect with -m 'not slow'",

glidepath-0.5.0/src/glidepath/__init__.py

@@ -0,0 +1,11 @@
+"""glidepath: a desktop retirement and investment planner (UK-first).
+
+``[project] version`` in pyproject.toml is the single version source
+(rewritten only by ``make bump``, planning §4.10); it reaches the
+installed distribution as metadata, and ``__version__`` merely reads
+it back — never state a version here.
+"""
+
+from importlib.metadata import version
+
+__version__ = version("glidepath")

{glidepath-0.3.0 → glidepath-0.5.0}/src/glidepath/app/__init__.py

@@ -105,6 +105,7 @@ from glidepath.app.firstrun import (
 )
 from glidepath.app.forms import (
     ENTITY_ID_KEY,
+    OWNER_KEY,
     ChoiceOption,
     FactsFormData,
     FactsFormResult,
@@ -112,6 +113,7 @@ from glidepath.app.forms import (
     FieldKind,
     FieldSpec,
     FormError,
+    PersonFormData,
     PlanEntityIds,
     SectionSpec,
     build_facts_form_view_model,
@@ -147,6 +149,13 @@ from glidepath.app.montecarlo import (
     run_mode_key,
     state_with_monte_carlo,
 )
+from glidepath.app.outlook import (
+    NO_OUTLOOK_MESSAGE,
+    OUTLOOK_HEADING,
+    OUTLOOK_NO_PLAN_MESSAGE,
+    OutlookPanelViewModel,
+    build_outlook_panel,
+)
 from glidepath.app.plan import (
     OVERRIDE_SOURCE,
     OverrideOutcome,
@@ -235,9 +244,13 @@ __all__ = [
     "NO_BACKTEST_MESSAGE",
     "NO_DRAWDOWN_MESSAGE",
     "NO_MONTE_CARLO_MESSAGE",
+    "NO_OUTLOOK_MESSAGE",
     "NO_PROJECTION_MESSAGE",
     "NO_RETIREMENT_MESSAGE",
+    "OUTLOOK_HEADING",
+    "OUTLOOK_NO_PLAN_MESSAGE",
     "OVERRIDE_SOURCE",
+    "OWNER_KEY",
     "REPORT_EXPORT_FAILED_PREFIX",
     "REPORT_NOT_WRITTEN_MESSAGE",
     "RETIREMENT_NO_INCOME_MESSAGE",
@@ -284,8 +297,10 @@ __all__ = [
     "LoadOutcome",
     "MonteCarloMetric",
     "MonteCarloPanelViewModel",
+    "OutlookPanelViewModel",
     "OverrideOutcome",
     "OverrideRow",
+    "PersonFormData",
     "PlanEntityIds",
     "PlanReport",
     "PlanState",
@@ -310,6 +325,7 @@ __all__ = [
     "build_drawdown_panel",
     "build_facts_form_view_model",
     "build_inspector_view_model",
+    "build_outlook_panel",
     "build_plan_report",
     "build_retirement_panel",
     "build_scenarios_view_model",

{glidepath-0.3.0 → glidepath-0.5.0}/src/glidepath/app/charts.py

@@ -10,7 +10,6 @@ inflation source (planning §5.2). Amounts stay ``Decimal`` here:
 converting them to plot coordinates is shell mechanics (§4.7).
 """
 
-from collections import Counter
 from dataclasses import dataclass
 from decimal import Decimal
 from typing import TYPE_CHECKING, Final
@@ -25,6 +24,7 @@ from glidepath.app.drawdown import (
     DrawdownPanelViewModel,
     build_drawdown_panel,
 )
+from glidepath.app.labels import numbered_unique
 from glidepath.app.montecarlo import (
     DEFAULT_RUN_MODE,
     FAN_MEDIAN_LABEL,
@@ -32,6 +32,10 @@ from glidepath.app.montecarlo import (
     MonteCarloPanelViewModel,
     build_monte_carlo_panel,
 )
+from glidepath.app.outlook import (
+    OutlookPanelViewModel,
+    build_outlook_panel,
+)
 from glidepath.app.retirement import (
     RetirementPanelViewModel,
     build_retirement_panel,
@@ -54,6 +58,7 @@ if TYPE_CHECKING:
         AssetAllocation,
         BacktestResult,
         EntityId,
+        Household,
         MonteCarloResult,
         Period,
         PeriodReportRow,
@@ -208,9 +213,9 @@ class ChartsViewModel:
     """The projection charts screen (roadmap 8.4).
 
     ``categories`` labels the shared x axis — one label per projected
-    period: the period-start year with the person's age at period
-    start alongside (roadmap 9.11; year alone until couples activate,
-    9.4 — a two-person period has no single age to show). ``message``
+    period: the period-start year with each person's age at period
+    start alongside (roadmap 9.11; both ages in household order for a
+    couple, e.g. ``2032 · 60/58`` — roadmap 9.31). ``message``
     carries the empty-state copy when there is nothing to chart; it
     is blank whenever ``charts`` is populated. ``allocation_note``
     states the asset allocation each wrapper actually ran — stated
@@ -227,6 +232,7 @@ class ChartsViewModel:
     message: str
     allocation_note: str
     monte_carlo: MonteCarloPanelViewModel
+    outlook: OutlookPanelViewModel
     retirement: RetirementPanelViewModel
     drawdown: DrawdownPanelViewModel
     backtest: BacktestPanelViewModel
@@ -366,6 +372,7 @@ def build_charts_view_model(
             monte_carlo=build_monte_carlo_panel(
                 state, mode, ending_pot_deflator=None, basis_suffix=suffix
             ),
+            outlook=build_outlook_panel(state),
             retirement=build_retirement_panel(state, mode),
             drawdown=build_drawdown_panel(state, mode),
             backtest=build_backtest_panel(
@@ -379,7 +386,7 @@ def build_charts_view_model(
     bands = _chart_bands(state, grouped, backtest_year)
     final_rows = next(reversed(grouped.values()))
     charts = [
-        _balances_chart(grouped, suffix, bands),
+        _balances_chart(grouped, suffix, bands, state.household),
         _income_chart(grouped, suffix),
         _tax_chart(grouped, suffix),
     ]
@@ -403,6 +410,7 @@ def build_charts_view_model(
             ending_pot_deflator=final_rows[0].balance_deflator,
             basis_suffix=suffix,
         ),
+        outlook=build_outlook_panel(state),
         retirement=build_retirement_panel(state, mode),
         drawdown=build_drawdown_panel(state, mode),
         backtest=build_backtest_panel(
@@ -493,7 +501,9 @@ def _allocation_note(
     household = state.household
     if household is None:
         return ""
-    labels = wrapper_display_labels(row for rows in grouped.values() for row in rows)
+    labels = wrapper_display_labels(
+        (row for rows in grouped.values() for row in rows), household
+    )
     glide = _glide_note(state)
     parts = []
     for person in household.persons:
@@ -512,17 +522,15 @@ def _allocation_note(
 
 
 def _category_label(period: Period, rows: list[PeriodReportRow]) -> str:
-    """One period's x-axis label: its start year, with the person's age.
+    """One period's x-axis label: its start year, with the persons' ages.
 
     ``2032 · 60`` reads the horizon in ages as well as calendar years
-    (roadmap 9.11). Only a single-person period carries an age — a
-    two-person household has no one age to label with (revisit with
-    couples activation, 9.4).
+    (roadmap 9.11); a two-person period labels both ages in household
+    order — ``2032 · 60/58`` (roadmap 9.31).
     """
     year = str(period.start.year)
-    if len(rows) == 1:
-        return f"{year} · {rows[0].age_at_period_start}"
-    return year
+    ages = "/".join(str(row.age_at_period_start) for row in rows)
+    return f"{year} · {ages}" if ages else year
 
 
 def _rows_by_period(
@@ -573,29 +581,34 @@ def _chart(
     )
 
 
-def wrapper_display_labels(rows: Iterable[PeriodReportRow]) -> dict[EntityId, str]:
+def wrapper_display_labels(
+    rows: Iterable[PeriodReportRow], household: Household | None = None
+) -> dict[EntityId, str]:
     """A display label per wrapper, in first-seen order.
 
-    The wrapper's kind name alone when unique; numbered in first-seen
-    order when the household holds several of one kind (entity ids are
-    generated UUIDs, so they are never shown as copy). Shared with the
-    cash-flow export (9.19), which columns its balances the same way
-    the balances chart stacks them.
+    A wrapper the user named shows its own label; the rest read their
+    kind name (entity ids are generated UUIDs, so they are never shown
+    as copy). Any name repeated across the final set — several unnamed
+    wrappers of one kind, a label colliding with a kind name, or one
+    label given twice in a hand-edited plan file — is numbered in
+    first-seen order (:func:`~glidepath.app.labels.numbered_unique`).
+    Shared with the cash-flow export (9.19), which columns its
+    balances the same way the balances chart stacks them.
     """
-    kinds: dict[EntityId, str] = {}
+    named: dict[EntityId, str] = {}
+    if household is not None:
+        named = {
+            wrapper.id: wrapper.label
+            for person in household.persons
+            for wrapper in person.wrappers
+            if wrapper.label is not None
+        }
+    bases: dict[EntityId, str] = {}
     for row in rows:
         for entry in row.wrapper_balances:
-            kinds.setdefault(entry.wrapper_id, format_wrapper_kind(entry.kind))
-    counts = Counter(kinds.values())
-    numbered: Counter[str] = Counter()
-    labels: dict[EntityId, str] = {}
-    for wrapper_id, kind in kinds.items():
-        if counts[kind] == 1:
-            labels[wrapper_id] = kind
-        else:
-            numbered[kind] += 1
-            labels[wrapper_id] = f"{kind} {numbered[kind]}"
-    return labels
+            base = named.get(entry.wrapper_id) or format_wrapper_kind(entry.kind)
+            bases.setdefault(entry.wrapper_id, base)
+    return numbered_unique(bases)
 
 
 def _deflated(
@@ -716,10 +729,13 @@ def _balances_chart(
     grouped: dict[Period, list[PeriodReportRow]],
     suffix: str,
     bands: tuple[ChartBand, ...],
+    household: Household | None,
 ) -> ChartSpec:
     """Closing balance per wrapper per period, stacked to the total."""
     series = []
-    labels = wrapper_display_labels(row for rows in grouped.values() for row in rows)
+    labels = wrapper_display_labels(
+        (row for rows in grouped.values() for row in rows), household
+    )
     for wrapper_id, label in labels.items():
         values = []
         for rows in grouped.values():

{glidepath-0.3.0 → glidepath-0.5.0}/src/glidepath/app/copy.py

@@ -113,8 +113,11 @@ HELP_GUIDE_SECTIONS: Final[tuple[tuple[str, str], ...]] = (
             "reproduce. "
             'The "When can I retire?" card answers with the earliest '
             "retirement age at which the plan sustains a target income — "
-            "a replacement rate you choose (66% of your employment income "
-            "by default) — on the selected run mode's basis: met with no "
+            "a replacement rate you choose (66% of your gross employment "
+            "income by default), enforced as after-tax spending money, so "
+            "the target is deliberately more demanding than the same "
+            "share of your take-home pay — on the selected run mode's "
+            "basis: met with no "
             "shortfall deterministically, or with at least your chosen "
             "Monte Carlo success rate. "
             'The "How much can I draw down?" card asks the same question '
@@ -124,6 +127,25 @@ HELP_GUIDE_SECTIONS: Final[tuple[tuple[str, str], ...]] = (
             "on the same selected basis."
         ),
     ),
+    (
+        "How spending is funded",
+        (
+            "In the projection, income already in payment — defined "
+            "benefit pension, state pension, annuity income — meets your "
+            "net spending need first, after the tax it bears. Whatever "
+            "remains is withdrawn from your wrappers in one fixed order: "
+            "general accounts and cash first (every pound left in them "
+            "keeps accruing income tax), then ISAs and LISAs, then "
+            "already-crystallised pension funds, and uncrystallised "
+            "pension funds last. This order is a deliberate "
+            "simplification — it is not configurable and the app never "
+            "searches for a personally optimal withdrawal sequence, "
+            "which would amount to tax advice. In some years a "
+            "different order could use an allowance this one leaves "
+            "idle, so treat the projection as a consistent baseline, "
+            "not the best achievable outcome."
+        ),
+    ),
     (
         "Scenarios — compare what-ifs",
         (

{glidepath-0.3.0 → glidepath-0.5.0}/src/glidepath/app/display.py

@@ -70,6 +70,8 @@ ASSUMPTION_NAMES: Final[Mapping[str, str]] = {
         "Annuity rate (inflation-linked, single life, age 65)"
     ),
     "annuity.age_adjustment": "Annuity rate age adjustment",
+    "db.survivor_fraction": "DB survivor pension fraction",
+    "spending.survivor_multiplier": "Survivor spending multiplier",
 }
 """Human display names for the shipped assumption keys (roadmap 8.3).
 
@@ -127,6 +129,13 @@ def format_recorded(moment: datetime) -> str:
     return moment.date().isoformat()
 
 
+def _format_temporal(value: date) -> str:
+    """A datetime (a recorded-on moment, and a date subclass) or a date."""
+    if isinstance(value, datetime):
+        return format_recorded(value)
+    return format_date(value)
+
+
 def format_value(value: object) -> str:
     """Any fact, decision, or assumption value as display text.
 
@@ -134,12 +143,12 @@ def format_value(value: object) -> str:
     numbers, enum choices, policy strings, and structured tables
     (rendered as compact ``key=value`` pairs, truncated when long).
     """
+    if isinstance(value, bool):  # before any numeric type: bool is an int
+        return "Yes" if value else "No"
     if isinstance(value, Money):
         return format_money(value)
-    if isinstance(value, datetime):  # before date: datetime is a date subclass
-        return format_recorded(value)
     if isinstance(value, date):
-        return format_date(value)
+        return _format_temporal(value)
     if isinstance(value, Enum):
         generic = str(value.name).replace("_", " ").capitalize()
         return _ENUM_LABELS.get(value, generic)