owlplanner 2025.5.12__tar.gz → 2025.5.15__tar.gz

owlplanner-2025.5.15/.streamlit/fullconfig.toml

@@ -0,0 +1,330 @@
+
+[global]
+
+# By default, Streamlit displays a warning when a user sets both a widget
+# default value in the function defining the widget and a widget value via
+# the widget's key in `st.session_state`.
+
+# If you'd like to turn off this warning, set this to True.
+
+# Default: false
+# disableWidgetStateDuplicationWarning = false
+
+# If True, will show a warning when you run a Streamlit-enabled script
+# via "python my_script.py".
+
+# Default: true
+# showWarningOnDirectExecution = true
+
+
+[logger]
+
+# Level of logging for Streamlit's internal logger: "error", "warning",
+# "info", or "debug".
+
+# Default: "info"
+# level = "info"
+
+# String format for logging messages. If logger.datetimeFormat is set,
+# logger messages will default to `%(asctime)s.%(msecs)03d %(message)s`. See
+# Python's documentation for available attributes:
+# https://docs.python.org/3/library/logging.html#formatter-objects
+
+# Default: "%(asctime)s %(message)s"
+# messageFormat = "%(asctime)s %(message)s"
+
+
+[client]
+
+# Controls whether uncaught app exceptions and deprecation warnings
+# are displayed in the browser. This can be one of the following:
+
+# - "full" : In the browser, Streamlit displays app deprecation
+# warnings and exceptions, including exception types,
+# exception messages, and associated tracebacks.
+# - "stacktrace" : In the browser, Streamlit displays exceptions,
+# including exception types, generic exception messages,
+# and associated tracebacks. Deprecation warnings and
+# full exception messages will only print to the
+# console.
+# - "type" : In the browser, Streamlit displays exception types and
+# generic exception messages. Deprecation warnings, full
+# exception messages, and associated tracebacks only
+# print to the console.
+# - "none" : In the browser, Streamlit displays generic exception
+# messages. Deprecation warnings, full exception
+# messages, associated tracebacks, and exception types
+# will only print to the console.
+# - True : This is deprecated. Streamlit displays "full"
+# error details.
+# - False : This is deprecated. Streamlit displays "stacktrace"
+# error details.
+
+# Default: [ "f", "u", "l", "l",]
+# showErrorDetails = [ "f", "u", "l", "l",]
+
+# Change the visibility of items in the toolbar, options menu,
+# and settings dialog (top right of the app).
+
+# Allowed values:
+# - "auto" : Show the developer options if the app is accessed through
+# localhost or through Streamlit Community Cloud as a developer.
+# Hide them otherwise.
+# - "developer" : Show the developer options.
+# - "viewer" : Hide the developer options.
+# - "minimal" : Show only options set externally (e.g. through
+# Streamlit Community Cloud) or through st.set_page_config.
+# If there are no options left, hide the menu.
+
+# Default: "auto"
+toolbarMode = "developer"
+
+# Controls whether to display the default sidebar page navigation in a
+# multi-page app. This only applies when app's pages are defined by the
+# `pages/` directory.
+
+# Default: true
+# showSidebarNavigation = true
+
+[runner]
+
+# Allows you to type a variable or string by itself in a single line of
+# Python code to write it to the app.
+
+# Default: true
+# magicEnabled = true
+
+# Handle script rerun requests immediately, rather than waiting for script
+# execution to reach a yield point. This makes Streamlit much more
+# responsive to user interaction, but it can lead to race conditions in
+# apps that mutate session_state data outside of explicit session_state
+# assignment statements.
+
+# Default: true
+# fastReruns = true
+
+# Raise an exception after adding unserializable data to Session State.
+# Some execution environments may require serializing all data in Session
+# State, so it may be useful to detect incompatibility during development,
+# or when the execution environment will stop supporting it in the future.
+
+# Default: false
+# enforceSerializableSessionState = false
+
+# Adjust how certain 'options' widgets like radio, selectbox, and
+# multiselect coerce Enum members when the Enum class gets re-defined
+# during a script re-run. For more information, check out the docs:
+# https://docs.streamlit.io/develop/concepts/design/custom-classes#enums
+
+# Allowed values:
+# - "off": Disables Enum coercion.
+# - "nameOnly": Enum classes can be coerced if their member names match.
+# - "nameAndValue": Enum classes can be coerced if their member names AND
+# member values match.
+
+# Default: "nameOnly"
+# enumCoercion = "nameOnly"
+
+
+[server]
+
+# List of folders that should not be watched for changes.
+
+# Relative paths will be taken as relative to the current working directory.
+
+# Example: ['/home/user1/env', 'relative/path/to/folder']
+
+# Default: []
+# folderWatchBlacklist = []
+
+# Change the type of file watcher used by Streamlit, or turn it off
+# completely.
+
+# Allowed values:
+# - "auto" : Streamlit will attempt to use the watchdog module, and
+# falls back to polling if watchdog is not available.
+# - "watchdog" : Force Streamlit to use the watchdog module.
+# - "poll" : Force Streamlit to always use polling.
+# - "none" : Streamlit will not watch files.
+
+# Default: "auto"
+# fileWatcherType = "auto"
+
+# Symmetric key used to produce signed cookies. If deploying on multiple
+# replicas, this should be set to the same value across all replicas to ensure
+# they all share the same secret.
+
+# Default: randomly generated secret key.
+# cookieSecret = "b87888855015f2bb50b408cb9d958bb52ea434cc6dacdf971c9e2b4997216925"
+
+# If false, will attempt to open a browser window on start.
+
+# Default: false unless (1) we are on a Linux box where DISPLAY is unset, or
+# (2) we are running in the Streamlit Atom plugin.
+# headless = false
+
+# Automatically rerun script when the file is modified on disk.
+
+# Default: false
+# runOnSave = false
+
+# The address where the server will listen for client and browser
+# connections. Use this if you want to bind the server to a specific address.
+# If set, the server will only be accessible from this address, and not from
+# any aliases (like localhost).
+
+# Default: (unset)
+# address =
+
+# The port where the server will listen for browser connections.
+
+# Don't use port 3000 which is reserved for internal development.
+
+# Default: 8501
+# port = 8501
+
+# The base path for the URL where Streamlit should be served from.
+
+# Default: ""
+# baseUrlPath = ""
+
+# Enables support for Cross-Origin Resource Sharing (CORS) protection,
+# for added security.
+
+# If XSRF protection is enabled and CORS protection is disabled at the
+# same time, Streamlit will enable them both instead.
+
+# Default: true
+# enableCORS = true
+
+# Enables support for Cross-Site Request Forgery (XSRF) protection, for
+# added security.
+
+# If XSRF protection is enabled and CORS protection is disabled at the
+# same time, Streamlit will enable them both instead.
+
+# Default: true
+# enableXsrfProtection = true
+
+# Max size, in megabytes, for files uploaded with the file_uploader.
+
+# Default: 200
+# maxUploadSize = 200
+
+# Max size, in megabytes, of messages that can be sent via the WebSocket
+# connection.
+
+# Default: 200
+# maxMessageSize = 200
+
+# Enables support for websocket compression.
+
+# Default: false
+# enableWebsocketCompression = false
+
+# Enable serving files from a `static` directory in the running app's
+# directory.
+
+# Default: false
+# enableStaticServing = false
+
+# TTL in seconds for sessions whose websockets have been disconnected. The server
+# may choose to clean up session state, uploaded files, etc for a given session
+# with no active websocket connection at any point after this time has passed.
+
+# Default: 120
+# disconnectedSessionTTL = 120
+
+# Server certificate file for connecting via HTTPS.
+# Must be set at the same time as "server.sslKeyFile".
+
+# ['DO NOT USE THIS OPTION IN A PRODUCTION ENVIRONMENT. It has not gone through security audits or performance tests. For the production environment, we recommend performing SSL termination by the load balancer or the reverse proxy.']
+# sslCertFile =
+
+# Cryptographic key file for connecting via HTTPS.
+# Must be set at the same time as "server.sslCertFile".
+
+# ['DO NOT USE THIS OPTION IN A PRODUCTION ENVIRONMENT. It has not gone through security audits or performance tests. For the production environment, we recommend performing SSL termination by the load balancer or the reverse proxy.']
+# sslKeyFile =
+
+
+[browser]
+
+# Internet address where users should point their browsers in order to
+# connect to the app. Can be IP address or DNS name and path.
+
+# This is used to:
+# - Set the correct URL for CORS and XSRF protection purposes.
+# - Show the URL on the terminal
+# - Open the browser
+
+# Default: "localhost"
+# serverAddress = "localhost"
+
+# Whether to send usage statistics to Streamlit.
+
+# Default: true
+# gatherUsageStats = true
+
+# Port where users should point their browsers in order to connect to the
+# app.
+
+# This is used to:
+# - Set the correct URL for XSRF protection purposes.
+# - Show the URL on the terminal (part of `streamlit run`).
+# - Open the browser automatically (part of `streamlit run`).
+
+# This option is for advanced use cases. To change the port of your app, use
+# `server.Port` instead. Don't use port 3000 which is reserved for internal
+# development.
+
+# Default: whatever value is set in server.port.
+# serverPort = 8501
+
+
+[mapbox]
+
+# Configure Streamlit to use a custom Mapbox
+# token for elements like st.pydeck_chart and st.map.
+# To get a token for yourself, create an account at
+# https://mapbox.com. It's free (for moderate usage levels)!
+
+# Default: ""
+# token = ""
+
+
+[theme]
+
+# The preset Streamlit theme that your custom theme inherits from.
+# One of "light" or "dark".
+# base =
+
+# Primary accent color for interactive elements.
+# primaryColor =
+
+# Background color for the main content area.
+# backgroundColor =
+
+# Background color used for the sidebar and most interactive widgets.
+# secondaryBackgroundColor =
+
+# Color used for almost all text.
+# textColor =
+
+# The font family for all text in the app, except code blocks. One of "sans serif",
+# "serif", or "monospace".
+# To use a custom font, it needs to be added via [theme.fontFaces].
+# font =
+
+
+[secrets]
+
+# List of locations where secrets are searched. An entry can be a path to a
+# TOML file or directory path where Kubernetes style secrets are saved.
+# Order is important, import is first to last, so secrets in later files
+# will take precedence over earlier ones.
+
+# Default: [ "C:\\Users\\marti\\.streamlit\\secrets.toml", "C:\\Users\\marti\\Dropbox\\Retirement\\MyProject\\Owl\\.streamlit\\.streamlit\\secrets.toml",]
+# files = [ "C:\\Users\\marti\\.streamlit\\secrets.toml", "C:\\Users\\marti\\Dropbox\\Retirement\\MyProject\\Owl\\.streamlit\\.streamlit\\secrets.toml",]
+
+

{owlplanner-2025.5.12 → owlplanner-2025.5.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: owlplanner
-Version: 2025.5.12
+Version: 2025.5.15
 Summary: Owl: Retirement planner with great wisdom
 Project-URL: HomePage, https://github.com/mdlacasse/owl
 Project-URL: Repository, https://github.com/mdlacasse/owl
@@ -693,9 +693,11 @@ Classifier: Topic :: Office/Business :: Financial :: Investment
 Requires-Python: >=3.8
 Requires-Dist: matplotlib
 Requires-Dist: numpy
+Requires-Dist: odfpy
 Requires-Dist: openpyxl
 Requires-Dist: pandas
 Requires-Dist: plotly
+Requires-Dist: pulp
 Requires-Dist: scipy
 Requires-Dist: seaborn
 Requires-Dist: streamlit

owlplanner-2025.5.15/docker/Dockerfile.build

@@ -0,0 +1,24 @@
+# docker/Dockerfile
+
+FROM python:3.13-slim
+
+WORKDIR /app
+
+RUN apt-get update; \
+    apt-get upgrade; \
+    apt-get install -y --no-install-recommends \
+        curl \
+        git \
+    ; \
+    rm -rf /var/lib/apt/lists/*
+
+COPY buildentrypoint.sh /usr/bin/entrypoint.sh
+COPY runentrypoint.sh /usr/bin/runentrypoint.sh
+
+RUN chmod 555 /usr/bin/entrypoint.sh /usr/bin/runentrypoint.sh
+
+EXPOSE 8501
+
+HEALTHCHECK CMD curl --fail http://localhost:8501/_stcore/health
+
+ENTRYPOINT ["/bin/bash", "/usr/bin/entrypoint.sh"]

owlplanner-2025.5.12/docker/Dockerfile → owlplanner-2025.5.15/docker/Dockerfile.run

@@ -12,20 +12,21 @@ RUN apt-get update; \
     ; \
     rm -rf /var/lib/apt/lists/*
 
-COPY fastentrypoint.sh /usr/bin/entrypoint.sh
+COPY runentrypoint.sh /usr/bin/entrypoint.sh
 
 RUN chmod 555 /usr/bin/entrypoint.sh
 
 # Build in the container for faster starts.
 RUN python -m pip install --no-cache-dir --upgrade pip
 
-RUN pip install --no-cache-dir build
+# RUN pip install --no-cache-dir build
+RUN rm -rf /app/owl
 
 RUN git clone --depth 1 https://github.com/mdlacasse/Owl.git owl
 
-RUN cd /app/owl && python -m build
-
-RUN cd /app/owl && pip install --no-cache-dir .
+RUN cd /app/owl && python -m pip install -r requirements.txt
+# RUN cd /app/owl && python -m build
+# RUN cd /app/owl && pip install --no-cache-dir .
 
 EXPOSE 8501
 

{owlplanner-2025.5.12 → owlplanner-2025.5.15}/docker/README.md

@@ -37,10 +37,14 @@ This approach requires cloning the Owl package from GitHub,
 and having both Python and Docker installed on your computer.
 
 ##### Docker image
+There are two images you can create. One builds Owl at run time, while
+the other builds it statically in the image.
+These two approaches trade startup time for image space
+(~300 MB vs. 1.8 GB, ~22 vs. 200 sec).
 First build the Docker image from the `docker` directory:
 ```shell
 cd docker
-docker build --no-cache -t owldocker .
+docker build --no-cache -f Dockerfile.{build or run} -t owldocker .
 ```
 
 #### Running the container

owlplanner-2025.5.15/docker/buildentrypoint.sh

@@ -0,0 +1,12 @@
+#/bin/bash
+
+# Build at run time for smaller image but slower starts.
+rm -rf /app/owl
+cd /app && git clone --depth 1 https://github.com/mdlacasse/Owl.git owl
+
+export OWLDIR=/app/owl
+
+python -m pip install --no-cache-dir --upgrade pip
+cd ${OWLDIR} && python -m pip install -r requirements.txt
+
+exec /usr/bin/runentrypoint.sh

owlplanner-2025.5.15/docker/runentrypoint.sh

@@ -0,0 +1,17 @@
+#/bin/bash
+
+if ! [[ -v OWLDIR ]]; then
+    OWLDIR=/app/owl
+fi
+
+export PYTHONPATH=${OWLDIR}/src:${PYTHONPATH}
+
+echo ""
+echo "Owl is now running locally: Point your browser to http://localhost:8501"
+
+if type -P streamlit >& /dev/null; then
+    streamlit run ${OWLDIR}/ui/main.py --server.port=8501 --server.address=0.0.0.0 --browser.gatherUsageStats=false
+else
+    python3 -m streamlit run ${OWLDIR}/ui/main.py --server.port=8501 --server.address=0.0.0.0 --browser.gatherUsageStats=false
+fi
+

{owlplanner-2025.5.12 → owlplanner-2025.5.15}/owlplanner.cmd

@@ -3,7 +3,6 @@
 set root=C:\Users\%username%\Anaconda3
 call %root%\Scripts\activate.bat
 
-cd ui
 where /q streamlit
 if ERRORLEVEL 1 (
     where /q python3
@@ -16,6 +15,6 @@ if ERRORLEVEL 1 (
     )
 ) else (
     echo Hit Ctrl-C to terminate the Streamlit server.
-    :: set PYTHONPATH=..\src;%PYTHONPATH%
-    call streamlit run main.py --browser.gatherUsageStats=false --browser.serverAddress=localhost
+    :: set PYTHONPATH=.\src;%PYTHONPATH%
+    call streamlit run .\ui\main.py --browser.gatherUsageStats=false --browser.serverAddress=localhost
 )

{owlplanner-2025.5.12 → owlplanner-2025.5.15}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "owlplanner"
-version = "2025.05.12"
+version = "2025.05.15"
 authors = [
   { name="Martin-D. Lacasse", email="martin.d.lacasse@gmail.com" },
 ]
@@ -26,9 +26,11 @@ classifiers = [
 dependencies = [
     "matplotlib",
     "numpy",
+    "odfpy",
     "openpyxl",
     "pandas",
     "plotly",
+    "pulp",
     "seaborn",
     "scipy",
     "streamlit",

{owlplanner-2025.5.12 → owlplanner-2025.5.15}/src/owlplanner/plotting/plotly_backend.py

@@ -345,7 +345,7 @@ class PlotlyBackend(PlotBackend):
         ]
 
         # Add histograms
-        for i, (dat, title) in enumerate(zip(data, ["S&P500", "BondsBaa", "TNotes", "Inflation"])):
+        for i, dat in enumerate(data):
             mean_val = np.mean(dat)
             label = f"<>: {u.pc(mean_val, 2, 1)}"
 
@@ -822,7 +822,7 @@ class PlotlyBackend(PlotBackend):
                     stack_names.append(aname)
 
                     # Get allocation data
-                    data = alpha_ijkn[i, acList.index(acType), assetDic[key], :len(year_n)]
+                    data = 100*alpha_ijkn[i, acList.index(acType), assetDic[key], :len(year_n)]
                     stack_data.append(data)
 
                 # Add stacked area traces
@@ -857,7 +857,7 @@ class PlotlyBackend(PlotBackend):
                 )
 
                 # Format y-axis as percentage
-                fig.update_yaxes(tickformat=".1f")
+                fig.update_yaxes(tickformat=".0f")
 
                 figures.append(fig)
 

owlplanner-2025.5.15/src/owlplanner/version.py

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

{owlplanner-2025.5.12 → owlplanner-2025.5.15}/ui/Documentation.py

@@ -420,7 +420,14 @@ These very pages.
 
 #### Settings
 This page allows to select different backends for plotting the graphs.
-Matplotlib is the most mature part of the code. Plotly still experimental.
+Matplotlib is the most mature part of the code. Plotly is still experimental.
+Owl currently defaults to matpotlib.
+
+When using Plotly, graphs are interactive. Users can zoom and pan, and toggle
+traces by clicking on the associated legend. Double clicking on a legend item
+selects only this item. Double-clicking on a disabled item restores all traces.
+A copy of the plot can also be saved as a *png* file. Both matplotlib and plotly
+graphs can be seen in full-screen mode.
 
 #### About Owl
 Credits and disclaimers.

owlplanner-2025.5.12/docker/fastentrypoint.sh

@@ -1,9 +0,0 @@
-#/bin/bash
-
-echo "Owl is now running locally: Point your browser to http://localhost:8501"
-if type -P streamlit >& /dev/null; then
-    streamlit run /app/owl/ui/main.py --server.port=8501 --server.address=0.0.0.0 --browser.gatherUsageStats=false
-else
-    python3 -m streamlit run /app/owl/ui/main.py --server.port=8501 --server.address=0.0.0.0 --browser.gatherUsageStats=false
-fi
-

owlplanner-2025.5.12/src/owlplanner/version.py

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

owlplanner-2025.5.12/ui/requirements.txt

@@ -1,11 +0,0 @@
-numpy
-matplotlib
-seaborn
-pandas
-openpyxl
-odfpy
-plotly
-pulp
-scipy
-streamlit
-toml