owlplanner 2025.2.21__tar.gz → 2025.2.22__tar.gz

{owlplanner-2025.2.21 → owlplanner-2025.2.22}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: owlplanner
-Version: 2025.2.21
+Version: 2025.2.22
 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.2.21 → owlplanner-2025.2.22}/examples/case_jack+jill.toml

@@ -1,4 +1,5 @@
 "Plan Name" = "jack+jill"
+Description = "This example case is for Jack and Jill, a married couple."
 
 ["Basic Info"]
 Status = "married"

{owlplanner-2025.2.21 → owlplanner-2025.2.22}/examples/case_joe.toml

@@ -1,4 +1,5 @@
 "Plan Name" = "joe"
+Description = "This example case is for Joe, a single individual."
 
 ["Basic Info"]
 Status = "single"

{owlplanner-2025.2.21 → owlplanner-2025.2.22}/examples/case_john+sally.toml

@@ -1,4 +1,5 @@
 "Plan Name" = "john+sally"
+Description = "This example reproduces the case of John and Sally, discussed by Eric Sajdak."
 
 ["Basic Info"]
 Status = "married"

{owlplanner-2025.2.21 → owlplanner-2025.2.22}/examples/case_jon+jane.toml

@@ -1,4 +1,5 @@
 "Plan Name" = "Jon+Jane"
+Description = "The case of Jon and Jane was the base case discussed by i-orp."
 
 ["Basic Info"]
 Status = "married"

{owlplanner-2025.2.21 → owlplanner-2025.2.22}/examples/case_kim+sam-bequest.toml

@@ -1,4 +1,5 @@
 "Plan Name" = "kim+sam-bequest"
+Description = "Kim and Sam is an example case for optimizing bequest and Roth conversions."
 
 ["Basic Info"]
 Status = "married"

{owlplanner-2025.2.21 → owlplanner-2025.2.22}/examples/case_kim+sam-spending.toml

@@ -1,4 +1,5 @@
 "Plan Name" = "kim+sam-spending"
+Description = "Kim and Sam is an example case for optimizing spending and Roth conversions."
 
 ["Basic Info"]
 Status = "married"

{owlplanner-2025.2.21 → owlplanner-2025.2.22}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "owlplanner"
-version = "2025.02.21"
+version = "2025.02.22"
 authors = [
   { name="Martin-D. Lacasse", email="martin.d.lacasse@gmail.com" },
 ]

{owlplanner-2025.2.21 → owlplanner-2025.2.22}/src/owlplanner/config.py

@@ -28,6 +28,7 @@ def saveConfig(plan, file, mylog):
 
     diconf = {}
     diconf["Plan Name"] = plan._name
+    diconf["Description"] = plan._description
 
     # Basic Info.
     diconf["Basic Info"] = {
@@ -185,6 +186,7 @@ def readConfig(file, *, verbose=True, logstreams=None, readContributions=True):
     s = ["", "s"][icount - 1]
     mylog.vprint(f"Plan for {icount} individual{s}: {inames}.")
     p = plan.Plan(inames, yobs, expectancy, name, startDate=startDate, verbose=True, logstreams=logstreams)
+    plan._description = diconf.get("Description", "")
 
     # Assets.
     balances = {}

{owlplanner-2025.2.21 → owlplanner-2025.2.22}/src/owlplanner/plan.py

@@ -239,6 +239,7 @@ class Plan(object):
         self.interpCenter = 15
         self.interpWidth = 5
 
+        self._description = ''
         self.defaultPlots = "nominal"
         self.defaultSolver = "HiGHS"
 
@@ -406,6 +407,12 @@ class Plan(object):
         self.mylog.vprint(f"Renaming plan {self._name} -> {newname}.")
         self._name = newname
 
+    def setDescription(self, description):
+        """
+        Set a text description of the plan.
+        """
+        self._description = description
+
     def setSpousalDepositFraction(self, eta):
         """
         Set spousal deposit and withdrawal fraction. Default 0.5.
@@ -2069,6 +2076,8 @@ class Plan(object):
         now = self.year_n[0]
         dic = {}
         # Results
+        dic["Plan name"] = self._name
+        dic["Brief description"] = self._description
         dic[f"Net yearly spending basis in {now}$"] = u.d(self.g_n[0] / self.xi_n[0])
         dic[f"Net yearly spending for year {now}"] = u.d(self.g_n[0] / self.yearFracLeft)
         dic[f"Net spending remaining in year {now}"] = u.d(self.g_n[0])

owlplanner-2025.2.22/src/owlplanner/version.py

@@ -0,0 +1 @@
+__version__ = "2025.02.22"

{owlplanner-2025.2.21 → owlplanner-2025.2.22}/ui/Create_Case.py

@@ -40,7 +40,6 @@ else:
             on_change=kz.renameCase,
             args=["caseNewName"],
             key="_caseNewName",
-            placeholder="Enter a name",
             help=helpmsg,
         )
 
@@ -61,6 +60,10 @@ else:
             horizontal=True,
         )
 
+    kz.initKey("description", "")
+    helpmsg = "Provide a short distinguishing description of the case."
+    description = kz.getText("Brief description", "description", help=helpmsg)
+
     col1, col2 = st.columns(2, gap="large", vertical_alignment="top")
     with col1:
         kz.initKey("iname0", "")

{owlplanner-2025.2.21 → owlplanner-2025.2.22}/ui/owlbridge.py

@@ -98,6 +98,7 @@ def prepareRun(plan):
             st.error(f"Failed setting beneficiary fractions: {e}")
             return
 
+    plan.setDescription(kz.getKey("description"))
     plan.setHeirsTaxRate(kz.getKey("heirsTx"))
     plan.setLongTermCapitalTaxRate(kz.getKey("gainTx"))
     plan.setDividendRate(kz.getKey("divRate"))
@@ -422,8 +423,11 @@ def plotSingleResults(plan):
         st.write("##### Assets Distribution")
         morecols = st.columns(3, gap="small")
         for fig in figs:
-            if fig is not None:
+            if fig:
                 morecols[c].pyplot(fig)
+            else:
+                morecols[c].write("#\n<div style='text-align: center'> This plot is empty </div>",
+                                  unsafe_allow_html=True)
             c = (c + 1) % 3
 
 
@@ -558,6 +562,7 @@ def genDic(plan):
     dic = {}
     dic["plan"] = plan
     dic["name"] = plan._name
+    dic["description"] = plan._description
     dic["summary"] = ""
     dic["casetoml"] = ""
     dic["caseStatus"] = "new"

{owlplanner-2025.2.21 → owlplanner-2025.2.22}/ui/requirements.txt

@@ -7,4 +7,4 @@ scipy
 streamlit
 toml
 # --extra-index-url https://test.pypi.org/simple
-owlplanner >= 2025.02.21
+owlplanner >= 2025.02.22

{owlplanner-2025.2.21 → owlplanner-2025.2.22}/ui/sskeys.py

@@ -438,7 +438,7 @@ def getNum(
     )
 
 
-def getText(text, nkey, disabled=False, callback=setpull, placeholder=None):
+def getText(text, nkey, disabled=False, callback=setpull, placeholder=None, help=None):
     return st.text_input(
         text,
         value=getKey(nkey),
@@ -447,6 +447,7 @@ def getText(text, nkey, disabled=False, callback=setpull, placeholder=None):
         args=[nkey],
         key="_" + nkey,
         placeholder=placeholder,
+        help=help,
     )
 
 

owlplanner-2025.2.21/src/owlplanner/version.py

@@ -1 +0,0 @@
-__version__ = "2025.02.21"