glidepath 0.5.0__tar.gz → 0.6.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: glidepath
-Version: 0.5.0
+Version: 0.6.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
@@ -32,10 +32,12 @@ Description-Content-Type: text/markdown
   <img src="https://raw.githubusercontent.com/williajm/glidepath/main/src/glidepath/gui/assets/wordmark.png" alt="glidepath" width="420">
 </p>
 
+[![PyPI](https://img.shields.io/pypi/v/glidepath)](https://pypi.org/project/glidepath/)
 [![CI](https://github.com/williajm/glidepath/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/williajm/glidepath/actions/workflows/ci.yml)
 [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=williajm_glidepath&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=williajm_glidepath)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=williajm_glidepath&metric=coverage)](https://sonarcloud.io/summary/new_code?id=williajm_glidepath)
-[![Python 3.14](https://img.shields.io/badge/python-3.14-blue)](https://github.com/williajm/glidepath/blob/main/.python-version)
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/williajm/glidepath/badge)](https://scorecard.dev/viewer/?uri=github.com/williajm/glidepath)
+[![Python versions](https://img.shields.io/pypi/pyversions/glidepath)](https://pypi.org/project/glidepath/)
 [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
@@ -203,7 +205,10 @@ carrying its notes from
 [`CHANGELOG.md`](https://github.com/williajm/glidepath/blob/main/CHANGELOG.md)
 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
+`gh attestation verify <file> -R williajm/glidepath`. The signed
+provenance bundle is attached to each release too
+(`glidepath-X.Y.Z-provenance.intoto.jsonl`), so verification also
+works offline with `--bundle`. There are no
 packaged binary builds (installer/exe) yet — install from PyPI as
 above.
 

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

@@ -4,10 +4,12 @@
   <img src="https://raw.githubusercontent.com/williajm/glidepath/main/src/glidepath/gui/assets/wordmark.png" alt="glidepath" width="420">
 </p>
 
+[![PyPI](https://img.shields.io/pypi/v/glidepath)](https://pypi.org/project/glidepath/)
 [![CI](https://github.com/williajm/glidepath/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/williajm/glidepath/actions/workflows/ci.yml)
 [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=williajm_glidepath&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=williajm_glidepath)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=williajm_glidepath&metric=coverage)](https://sonarcloud.io/summary/new_code?id=williajm_glidepath)
-[![Python 3.14](https://img.shields.io/badge/python-3.14-blue)](https://github.com/williajm/glidepath/blob/main/.python-version)
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/williajm/glidepath/badge)](https://scorecard.dev/viewer/?uri=github.com/williajm/glidepath)
+[![Python versions](https://img.shields.io/pypi/pyversions/glidepath)](https://pypi.org/project/glidepath/)
 [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
@@ -175,7 +177,10 @@ carrying its notes from
 [`CHANGELOG.md`](https://github.com/williajm/glidepath/blob/main/CHANGELOG.md)
 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
+`gh attestation verify <file> -R williajm/glidepath`. The signed
+provenance bundle is attached to each release too
+(`glidepath-X.Y.Z-provenance.intoto.jsonl`), so verification also
+works offline with `--bundle`. There are no
 packaged binary builds (installer/exe) yet — install from PyPI as
 above.
 

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

@@ -1,6 +1,6 @@
 [project]
 name = "glidepath"
-version = "0.5.0"
+version = "0.6.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 —

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

@@ -105,11 +105,17 @@ from glidepath.app.firstrun import (
 )
 from glidepath.app.forms import (
     ENTITY_ID_KEY,
+    HIDE_ADVANCED_LABEL,
+    INCOME_PREFERENCE_ANNUITY,
+    INCOME_PREFERENCE_KEY,
     OWNER_KEY,
+    REQUIRED_MARKER,
+    SHOW_ADVANCED_LABEL,
     ChoiceOption,
     FactsFormData,
     FactsFormResult,
     FactsFormViewModel,
+    FactsSubmissionOutcome,
     FieldKind,
     FieldSpec,
     FormError,
@@ -150,6 +156,7 @@ from glidepath.app.montecarlo import (
     state_with_monte_carlo,
 )
 from glidepath.app.outlook import (
+    DETERMINISTIC_BASIS_SENTENCE,
     NO_OUTLOOK_MESSAGE,
     OUTLOOK_HEADING,
     OUTLOOK_NO_PLAN_MESSAGE,
@@ -162,6 +169,7 @@ from glidepath.app.plan import (
     PlanState,
     facts_saved_message,
     initial_plan_state,
+    plan_run_config,
     state_marked_saved,
     state_with_household,
     state_with_override,
@@ -219,6 +227,7 @@ __all__ = [
     "DEFAULT_CHART_BASIS",
     "DEFAULT_COMPARISON_METRIC_KEY",
     "DEFAULT_RUN_MODE",
+    "DETERMINISTIC_BASIS_SENTENCE",
     "DISCLAIMER_ACCEPT_LABEL",
     "DISCLAIMER_BODY",
     "DISCLAIMER_DECLINE_LABEL",
@@ -233,6 +242,9 @@ __all__ = [
     "HELP_GUIDE_SECTIONS",
     "HELP_GUIDE_TITLE",
     "HELP_MENU_LABEL",
+    "HIDE_ADVANCED_LABEL",
+    "INCOME_PREFERENCE_ANNUITY",
+    "INCOME_PREFERENCE_KEY",
     "MONTE_CARLO_CHART_TITLE",
     "MONTE_CARLO_NO_PLAN_MESSAGE",
     "MONTE_CARLO_PATHS_MESSAGE",
@@ -253,6 +265,7 @@ __all__ = [
     "OWNER_KEY",
     "REPORT_EXPORT_FAILED_PREFIX",
     "REPORT_NOT_WRITTEN_MESSAGE",
+    "REQUIRED_MARKER",
     "RETIREMENT_NO_INCOME_MESSAGE",
     "RETIREMENT_NO_PLAN_MESSAGE",
     "RETIREMENT_RATE_MESSAGE",
@@ -260,6 +273,7 @@ __all__ = [
     "RETIREMENT_STALE_MESSAGE",
     "RETIREMENT_SUCCESS_MESSAGE",
     "RUN_FAILED_PREFIX",
+    "SHOW_ADVANCED_LABEL",
     "TABLE_VIEW_LABEL",
     "UNSAVED_CHANGES_PROMPT",
     "UNSAVED_CHANGES_TITLE",
@@ -286,6 +300,7 @@ __all__ = [
     "FactsFormData",
     "FactsFormResult",
     "FactsFormViewModel",
+    "FactsSubmissionOutcome",
     "FieldKind",
     "FieldSpec",
     "FileMenuViewModel",
@@ -357,6 +372,7 @@ __all__ = [
     "path_pool",
     "plan_display_name",
     "plan_entity_ids",
+    "plan_run_config",
     "record_disclaimer_acknowledged",
     "record_last_plan_path",
     "report_exported_message",

{glidepath-0.5.0 → glidepath-0.6.0}/src/glidepath/app/backtest.py

@@ -19,8 +19,8 @@ from typing import TYPE_CHECKING, Any, Final
 
 from glidepath.app.display import format_money, format_percent
 from glidepath.app.montecarlo import BAND_SPECS, SUCCESS_RATE_LABEL
-from glidepath.app.plan import PlanState, region_for, replanned_state
-from glidepath.core import Money, RunConfig, run_windows
+from glidepath.app.plan import PlanState, plan_run_config, region_for, replanned_state
+from glidepath.core import Money, run_windows
 from glidepath.regions.uk import load_returns_history
 
 if TYPE_CHECKING:
@@ -122,7 +122,7 @@ def state_with_backtest(state: PlanState, *, today: date) -> PlanState:
         today=today,
         modified=state.modified,
     )
-    config = RunConfig(today=today)
+    config = plan_run_config(state.household, today=today)
     try:
         series = load_returns_history().series
         result = run_windows(

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

@@ -58,15 +58,23 @@ HELP_GUIDE_SECTIONS: Final[tuple[tuple[str, str], ...]] = (
             "pension, SIPP, ISA, LISA, general account, or cash) with its "
             "balance, contributions, and optionally its own equity "
             "allocation percentage — blank follows the de-risking glide "
-            "path, 100 models an all-equity wrapper — any defined "
-            "benefit pension, and "
-            "any planned annuity purchase — converting part of your "
-            "pension pot into lifetime income at an age you choose. "
-            "Drawdown is the default: anything you do not annuitise "
-            "stays invested, a fraction of 1 annuitises the whole pot, "
-            "and several purchases at different ages annuitise in "
-            "stages. "
-            "Add one wrapper, DB, or annuity section per item. Dates can "
+            "path, 100 models an all-equity wrapper — and any defined "
+            "benefit pension. "
+            "The Retirement income section holds two choices: a "
+            "preference between drawdown only (the default — everything "
+            "stays invested and is withdrawn as needed) and an annuity "
+            "or a mix, which adds a section right below to plan annuity "
+            "purchases — converting a percentage of your pension pot "
+            "into lifetime income at an age you choose, 100% "
+            "annuitising the whole pot and several purchases at "
+            "different ages annuitising in stages — and a drawdown withdrawal "
+            "strategy: fixed real spending (the default), a fixed "
+            "percentage of the pot, guardrails, or natural yield. "
+            "Add one wrapper, DB, or annuity section per item. "
+            "Fields marked * are required, hovering any field repeats "
+            'its guidance, and each section\'s "More options" reveals '
+            "its rarely needed fields — anything already filled in, or "
+            "in error, is shown automatically. Dates can "
             "be typed or picked from the calendar assist, and the "
             '"as of" dates on balances and your state pension forecast '
             "default to today when left blank. Your state pension needs "
@@ -74,8 +82,8 @@ HELP_GUIDE_SECTIONS: Final[tuple[tuple[str, str], ...]] = (
             "the app never re-derives what DWP has already computed. "
             'Press "Save facts and project" to run the '
             "projection — if anything cannot be read, the message under "
-            "the buttons says which field to fix and nothing is saved "
-            "until it parses."
+            "the buttons and a note under each affected field say what "
+            "to fix, and nothing is saved until it parses."
         ),
     ),
     (
@@ -133,7 +141,10 @@ HELP_GUIDE_SECTIONS: Final[tuple[tuple[str, str], ...]] = (
             "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: "
+            "remains is withdrawn from your wrappers. How *much* is "
+            "drawn each year follows the withdrawal strategy you chose "
+            "on the Facts tab (fixed real spending by default); which "
+            "wrapper it comes from follows 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 "
@@ -143,7 +154,10 @@ HELP_GUIDE_SECTIONS: Final[tuple[tuple[str, str], ...]] = (
             "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."
+            "not the best achievable outcome. The 'When can I retire?' "
+            "and 'How much can I draw down?' cards always answer their "
+            "questions in fixed real spending terms, whatever strategy "
+            "the plan itself runs."
         ),
     ),
     (

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

@@ -12,7 +12,7 @@ from decimal import Decimal
 from enum import Enum
 from typing import Final
 
-from glidepath.core import LifeStage, Money
+from glidepath.core import LifeStage, Money, WithdrawalRule, WithdrawalRuleKind
 
 _MAX_STRUCTURED_LENGTH = 120
 
@@ -24,6 +24,14 @@ _ENUM_LABELS: Final[Mapping[Enum, str]] = {
 """Enum members whose copy the generic underscore rule would mangle
 ("Go go"); the retirement sub-stages read hyphenated (issue #114)."""
 
+WITHDRAWAL_RULE_NAMES: Final[Mapping[WithdrawalRuleKind, str]] = {
+    WithdrawalRuleKind.FIXED_REAL: "Fixed real spending",
+    WithdrawalRuleKind.FIXED_PERCENT: "Fixed percentage of pot",
+    WithdrawalRuleKind.GUARDRAILS: "Guardrails (cut or raise on crossings)",
+    WithdrawalRuleKind.NATURAL_YIELD: "Natural yield only",
+}
+"""Display names for the withdrawal-strategy decision (planning §5.1)."""
+
 WRAPPER_KIND_NAMES: Final[Mapping[str, str]] = {
     "uk.workplace_dc": "Workplace DC",
     "uk.sipp": "SIPP",
@@ -86,6 +94,14 @@ def format_assumption_key(key: object) -> str:
     return ASSUMPTION_NAMES.get(text, text)
 
 
+def _format_withdrawal_rule(rule: WithdrawalRule) -> str:
+    """The withdrawal-strategy decision's value as display text (10.3)."""
+    name = WITHDRAWAL_RULE_NAMES[rule.kind]
+    if rule.rate is None:
+        return name
+    return f"{name} ({format_share(rule.rate.value)} a year)"
+
+
 def _format_mapping(value: Mapping[object, object]) -> str:
     """A structured table as compact ``key=value`` pairs, truncated."""
     rendered = "; ".join(f"{key}={format_value(entry)}" for key, entry in value.items())
@@ -143,15 +159,25 @@ 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, date):
-        return _format_temporal(value)
+    special = _format_special(value)
+    if special is not None:
+        return special
     if isinstance(value, Enum):
         generic = str(value.name).replace("_", " ").capitalize()
         return _ENUM_LABELS.get(value, generic)
     if isinstance(value, Mapping):
         return _format_mapping(value)
     return str(value)
+
+
+def _format_special(value: object) -> str | None:
+    """The non-enum, non-table special cases; ``None`` to fall through."""
+    if isinstance(value, bool):  # before any numeric type: bool is an int
+        return "Yes" if value else "No"
+    if isinstance(value, WithdrawalRule):
+        return _format_withdrawal_rule(value)
+    if isinstance(value, Money):
+        return format_money(value)
+    if isinstance(value, date):
+        return _format_temporal(value)
+    return None