owlplanner 2025.5.2__tar.gz → 2025.5.5__tar.gz

{owlplanner-2025.5.2 → owlplanner-2025.5.5}/.devcontainer/devcontainer.json

@@ -1,33 +1,33 @@
-{
-  "name": "Python 3",
-  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
-  "image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
-  "customizations": {
-    "codespaces": {
-      "openFiles": [
-        "README.md",
-        "ui/main.py"
-      ]
-    },
-    "vscode": {
-      "settings": {},
-      "extensions": [
-        "ms-python.python",
-        "ms-python.vscode-pylance"
-      ]
-    }
-  },
-  "updateContentCommand": "[ -f packages.txt ] && sudo apt update && sudo apt upgrade -y && sudo xargs apt install -y <packages.txt; [ -f requirements.txt ] && pip3 install --user -r requirements.txt; pip3 install --user streamlit; echo '✅ Packages installed and Requirements met'",
-  "postAttachCommand": {
-    "server": "streamlit run ui/main.py --server.enableCORS false --server.enableXsrfProtection false"
-  },
-  "portsAttributes": {
-    "8501": {
-      "label": "Application",
-      "onAutoForward": "openPreview"
-    }
-  },
-  "forwardPorts": [
-    8501
-  ]
+{
+  "name": "Python 3",
+  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+  "image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
+  "customizations": {
+    "codespaces": {
+      "openFiles": [
+        "README.md",
+        "ui/main.py"
+      ]
+    },
+    "vscode": {
+      "settings": {},
+      "extensions": [
+        "ms-python.python",
+        "ms-python.vscode-pylance"
+      ]
+    }
+  },
+  "updateContentCommand": "[ -f packages.txt ] && sudo apt update && sudo apt upgrade -y && sudo xargs apt install -y <packages.txt; [ -f requirements.txt ] && pip3 install --user -r requirements.txt; pip3 install --user streamlit; echo '✅ Packages installed and Requirements met'",
+  "postAttachCommand": {
+    "server": "streamlit run ui/main.py --server.enableCORS false --server.enableXsrfProtection false"
+  },
+  "portsAttributes": {
+    "8501": {
+      "label": "Application",
+      "onAutoForward": "openPreview"
+    }
+  },
+  "forwardPorts": [
+    8501
+  ]
 }

{owlplanner-2025.5.2 → owlplanner-2025.5.5}/.flake8

@@ -1,6 +1,5 @@
 [flake8]
 max-line-length = 120
-max-complexity = 70
 # These checks violate PEP8 so let's ignore them
 extend-ignore = E203
 # extend-exclude = */site-packages/*

{owlplanner-2025.5.2 → owlplanner-2025.5.5}/.gitignore

@@ -4,6 +4,7 @@ dist
 *~
 *.aux
 *.log
+.coverage
 otherFiles
 myfiles
 secrets

{owlplanner-2025.5.2 → owlplanner-2025.5.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: owlplanner
-Version: 2025.5.2
+Version: 2025.5.5
 Summary: Owl: Retirement planner with great wisdom
 Project-URL: HomePage, https://github.com/mdlacasse/owl
 Project-URL: Repository, https://github.com/mdlacasse/owl

{owlplanner-2025.5.2 → owlplanner-2025.5.5}/examples/case_jon+jane.toml

@@ -1,57 +1,57 @@
-"Plan Name" = "Jon+Jane"
-Description = "This case reproduces a similar case discussed a while back on i-orp. It involves Jon and Jane close to retirement, and assumes a base case of optimistic returns of 10% with an inflation of 3.5%. A wages and contributions file called 'jon+jane.xlsx' is associated with this case."
-
-["Basic Info"]
-Status = "married"
-Names = [ "Jon", "Jane",]
-"Birth year" = [ 1965, 1968,]
-"Life expectancy" = [ 92, 92,]
-"Start date" = "01-01"
-
-[Assets]
-"taxable savings balances" = [ 50.0, 0.0,]
-"tax-deferred savings balances" = [ 900.0, 500.0,]
-"tax-free savings balances" = [ 0.0, 0.0,]
-"Beneficiary fractions" = [ 1.0, 1.0, 1.0,]
-"Spousal surplus deposit fraction" = 0.0
-
-["Wages and Contributions"]
-"Contributions file name" = "edited values"
-
-["Fixed Income"]
-"Pension amounts" = [ 0.0, 0.0,]
-"Pension ages" = [ 65, 65,]
-"Pension indexed" = [ false, false,]
-"Social security amounts" = [ 21.0, 21.0,]
-"Social security ages" = [ 65, 65,]
-
-["Rates Selection"]
-"Heirs rate on tax-deferred estate" = 30.0
-"Long-term capital gain tax rate" = 15.0
-"Dividend tax rate" = 2.0
-"TCJA expiration year" = 2026
-Method = "user"
-Values = [ 10.0, 0.0, 0.0, 3.5000000000000004,]
-From = 1928
-To = 2024
-
-["Asset Allocation"]
-"Interpolation method" = "linear"
-"Interpolation center" = 15.0
-"Interpolation width" = 5.0
-Type = "individual"
-generic = [ [ [ 100, 0, 0, 0,], [ 100, 0, 0, 0,],], [ [ 100, 0, 0, 0,], [ 100, 0, 0, 0,],],]
-
-["Optimization Parameters"]
-"Spending profile" = "flat"
-"Surviving spouse spending percent" = 60
-Objective = "maxSpending"
-
-["Solver Options"]
-maxRothConversion = 0.0
-noRothConversions = "None"
-withMedicare = true
-bequest = 30.0
-
-[Results]
-"Default plots" = "today"
+"Plan Name" = "Jon+Jane"
+Description = "This case reproduces a similar case discussed a while back on i-orp. It involves Jon and Jane close to retirement, and assumes a base case of optimistic returns of 10% with an inflation of 3.5%. A wages and contributions file called 'jon+jane.xlsx' is associated with this case."
+
+["Basic Info"]
+Status = "married"
+Names = [ "Jon", "Jane",]
+"Birth year" = [ 1965, 1968,]
+"Life expectancy" = [ 92, 92,]
+"Start date" = "01-01"
+
+[Assets]
+"taxable savings balances" = [ 50.0, 0.0,]
+"tax-deferred savings balances" = [ 900.0, 500.0,]
+"tax-free savings balances" = [ 0.0, 0.0,]
+"Beneficiary fractions" = [ 1.0, 1.0, 1.0,]
+"Spousal surplus deposit fraction" = 0.0
+
+["Wages and Contributions"]
+"Contributions file name" = "edited values"
+
+["Fixed Income"]
+"Pension amounts" = [ 0.0, 0.0,]
+"Pension ages" = [ 65, 65,]
+"Pension indexed" = [ false, false,]
+"Social security amounts" = [ 21.0, 21.0,]
+"Social security ages" = [ 65, 65,]
+
+["Rates Selection"]
+"Heirs rate on tax-deferred estate" = 30.0
+"Long-term capital gain tax rate" = 15.0
+"Dividend tax rate" = 2.0
+"TCJA expiration year" = 2026
+Method = "user"
+Values = [ 10.0, 0.0, 0.0, 3.5000000000000004,]
+From = 1928
+To = 2024
+
+["Asset Allocation"]
+"Interpolation method" = "linear"
+"Interpolation center" = 15.0
+"Interpolation width" = 5.0
+Type = "individual"
+generic = [ [ [ 100, 0, 0, 0,], [ 100, 0, 0, 0,],], [ [ 100, 0, 0, 0,], [ 100, 0, 0, 0,],],]
+
+["Optimization Parameters"]
+"Spending profile" = "flat"
+"Surviving spouse spending percent" = 60
+Objective = "maxSpending"
+
+["Solver Options"]
+maxRothConversion = 0.0
+noRothConversions = "None"
+withMedicare = true
+bequest = 30.0
+
+[Results]
+"Default plots" = "today"

{owlplanner-2025.5.2 → owlplanner-2025.5.5}/notebooks/kim+sam.ipynb

@@ -1,222 +1,222 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "b39a3609-b306-470f-89d5-4710794b2008",
-   "metadata": {},
-   "source": [
-    "## Another short example to use as a template."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "63c9604f-4e6e-4e72-93d7-cdb5788d81d5",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import owlplanner as owl"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "40025313-4ed5-4e6e-8eca-dc084830ca21",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "p = owl.Plan(['Kim', 'Sam'], [1966, 1967], [86, 89], 'kim+sam-spending', verbose=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "435a0599-accb-42cd-a1c2-382b97383626",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# p.setPension([0, 0], [65, 65])\n",
-    "p.setSocialSecurity([45, 25], [70, 68])"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "0b622cd0-f176-4a2f-8470-a0b457294e87",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "p.setSpendingProfile('smile', 60)\n",
-    "# p.setSpendingProfile('flat', 60)\n",
-    "p.showProfile()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "dbbf9e2f-7fb1-4861-874f-0d987966ebfb",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "#p.setRates('historical', 1998)\n",
-    "p.setRates('conservative')\n",
-    "#p.setRates('historical', 1966)\n",
-    "p.showRates()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "31eec280-acdb-40d0-9404-d508a60cf206",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "p.setAccountBalances(taxable=[1000, 0], taxDeferred=[2000, 800], taxFree=[500, 25])"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "45f2bb63-f6c6-42a1-a112-fd8e8146f470",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "p.readContributions('../examples/template.xlsx')"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "747f1a39-501e-4560-b856-b838720289fe",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "p.setHeirsTaxRate(33)\n",
-    "p.setLongTermCapitalTaxRate(15)\n",
-    "p.setInterpolationMethod('s-curve')\n",
-    "p.setAllocationRatios(\n",
-    "    'individual',\n",
-    "    generic=[[[60, 40, 0, 0], [70, 30, 0, 0]], [[60, 40, 0, 0], [70, 30, 0, 0]]]\n",
-    ")\n",
-    "p.showAllocations()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "0e153434-a9ba-4ced-b138-4dc0e844ac0f",
-   "metadata": {},
-   "source": [
-    "### Optimize spending and save workbook."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "ede7fa05-8a6e-41b4-8b7c-a217d28ad41b",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "%%time\n",
-    "options = {'maxRothConversion': 300, 'bequest': 2000}\n",
-    "p.solve('maxSpending', options=options)\n",
-    "p.saveConfig()\n",
-    "p.summary()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "525f22e2-d241-4fa8-bc95-82d758238326",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "p.setDefaultPlots('today')\n",
-    "p.showNetSpending()\n",
-    "p.showGrossIncome()\n",
-    "p.showTaxes()\n",
-    "p.showSources()\n",
-    "p.showAccounts()\n",
-    "p.showAssetDistribution()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "1202e86b-4f08-4158-8546-6105da68f77a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "p.saveWorkbook(True)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "a7469daf-61b8-42a4-bcb8-22c801014d8c",
-   "metadata": {},
-   "source": [
-    "### Optimize bequest and save workbook."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "73c77134-4b50-42f4-bd2d-d7eb59c5e750",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "%%time\n",
-    "options = {'maxRothConversion': 300, 'netSpending': 180}\n",
-    "p.rename('case_kim+sam-bequest')\n",
-    "p.solve('maxBequest', options=options)\n",
-    "p.saveConfig()\n",
-    "p.summary()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "0164a9df-1943-4ead-a0af-71ed502c6417",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "p.showNetSpending()\n",
-    "p.showGrossIncome()\n",
-    "p.showTaxes()\n",
-    "p.showSources()\n",
-    "p.showAccounts()\n",
-    "p.showAssetDistribution()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "2206eda7-7534-4b78-a58b-ad9879295fae",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "p.saveWorkbook(True)"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.12.7"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "b39a3609-b306-470f-89d5-4710794b2008",
+   "metadata": {},
+   "source": [
+    "## Another short example to use as a template."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "63c9604f-4e6e-4e72-93d7-cdb5788d81d5",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import owlplanner as owl"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "40025313-4ed5-4e6e-8eca-dc084830ca21",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "p = owl.Plan(['Kim', 'Sam'], [1966, 1967], [86, 89], 'kim+sam-spending', verbose=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "435a0599-accb-42cd-a1c2-382b97383626",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# p.setPension([0, 0], [65, 65])\n",
+    "p.setSocialSecurity([45, 25], [70, 68])"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "0b622cd0-f176-4a2f-8470-a0b457294e87",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "p.setSpendingProfile('smile', 60)\n",
+    "# p.setSpendingProfile('flat', 60)\n",
+    "p.showProfile()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "dbbf9e2f-7fb1-4861-874f-0d987966ebfb",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#p.setRates('historical', 1998)\n",
+    "p.setRates('conservative')\n",
+    "#p.setRates('historical', 1966)\n",
+    "p.showRates()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "31eec280-acdb-40d0-9404-d508a60cf206",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "p.setAccountBalances(taxable=[1000, 0], taxDeferred=[2000, 800], taxFree=[500, 25])"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "45f2bb63-f6c6-42a1-a112-fd8e8146f470",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "p.readContributions('../examples/template.xlsx')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "747f1a39-501e-4560-b856-b838720289fe",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "p.setHeirsTaxRate(33)\n",
+    "p.setLongTermCapitalTaxRate(15)\n",
+    "p.setInterpolationMethod('s-curve')\n",
+    "p.setAllocationRatios(\n",
+    "    'individual',\n",
+    "    generic=[[[60, 40, 0, 0], [70, 30, 0, 0]], [[60, 40, 0, 0], [70, 30, 0, 0]]]\n",
+    ")\n",
+    "p.showAllocations()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "0e153434-a9ba-4ced-b138-4dc0e844ac0f",
+   "metadata": {},
+   "source": [
+    "### Optimize spending and save workbook."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "ede7fa05-8a6e-41b4-8b7c-a217d28ad41b",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%%time\n",
+    "options = {'maxRothConversion': 300, 'bequest': 2000}\n",
+    "p.solve('maxSpending', options=options)\n",
+    "p.saveConfig()\n",
+    "p.summary()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "525f22e2-d241-4fa8-bc95-82d758238326",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "p.setDefaultPlots('today')\n",
+    "p.showNetSpending()\n",
+    "p.showGrossIncome()\n",
+    "p.showTaxes()\n",
+    "p.showSources()\n",
+    "p.showAccounts()\n",
+    "p.showAssetDistribution()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "1202e86b-4f08-4158-8546-6105da68f77a",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "p.saveWorkbook(True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "a7469daf-61b8-42a4-bcb8-22c801014d8c",
+   "metadata": {},
+   "source": [
+    "### Optimize bequest and save workbook."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "73c77134-4b50-42f4-bd2d-d7eb59c5e750",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%%time\n",
+    "options = {'maxRothConversion': 300, 'netSpending': 180}\n",
+    "p.rename('case_kim+sam-bequest')\n",
+    "p.solve('maxBequest', options=options)\n",
+    "p.saveConfig()\n",
+    "p.summary()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "0164a9df-1943-4ead-a0af-71ed502c6417",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "p.showNetSpending()\n",
+    "p.showGrossIncome()\n",
+    "p.showTaxes()\n",
+    "p.showSources()\n",
+    "p.showAccounts()\n",
+    "p.showAssetDistribution()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "2206eda7-7534-4b78-a58b-ad9879295fae",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "p.saveWorkbook(True)"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.12.7"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}