Repository navigation
okama Planner v0.1.0
First public release of okama Planner, under the MIT license, with a clean repository history.
A standalone household financial-planning library powered by okama.FinPlan. The complete
request produces a monthly cash-flow ledger, loan and savings schedules, goal outcomes,
Monte Carlo metrics, portfolio and net-capital chart series, and numerical provenance.
The offline synthetic example compares a property purchase in July 2028 with July 2029 using
500 paths and seed 42. Full-plan success is 0.974 / 0.972; terminal portfolio medians are
25291.057126370935 / 25412.62632800031 USD. These are synthetic examples, not market forecasts.
Both complete results are attached and available in examples/.
Included: one investment portfolio with accumulation and retirement withdrawals; budgets,
fixed-payment loans, liquid reserves, non-working assets and dated goals. Goal-specific investment
portfolios, gamma/equivalent alpha, FX, jurisdictional taxes, white label reports and a web app
remain future work. The example script is a usage helper; no separate product CLI is required.
Use Python 3.11 and the installation/reproduction instructions in the README. The wheel and source
archive are attached with SHA256SUMS. A fresh source installation passed all 216 tests and Ruff;
both example calculations were exercised locally and in GitHub CI.
The optional local MCP integration is available in okama-mcp main.
Install this companion into the server environment. Existing indexed okama-mcp packages and the
public HTTP server have not been updated for this integration.