refactor: move recommendations in copilot submodule

Author: MadeInPierre

README.md

@@ -26,7 +26,7 @@ Don't have Finary yet? You can sign up using my [referral link](https://finary.c
 🇫🇷🥖 Vous pouvez traduire cette page en Français avec votre navigateur (_clic droit > traduire_).
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/MadeInPierre/finalynx/main/docs/_static/screenshot_demo.png" width="600" />
+  <img src="https://raw.githubusercontent.com/MadeInPierre/finalynx/main/docs/_static/screenshot_demo_frameless.png" width="600" />
 </p>
 
 ## ✨ Features
@@ -65,8 +65,8 @@ Here is the bare minimum code accepted:
 
 ```python
 from finalynx import Portfolio, Assistant
-portfolio = Portfolio()  # <- your custom configuration here
-Assistant(portfolio).run()
+portfolio = Portfolio()     # <- your custom configuration here
+Assistant(portfolio).run()  # <- see tutorials for more options
 ```
 
 You can now populate the `Portfolio` class with your own custom hierarchy by taking inspiration from the [`demo.py`](https://github.com/MadeInPierre/finalynx/blob/main/examples/demo.py) example or by reading the [Getting Started](https://finalynx.readthedocs.io/en/latest/quickstart/getting_started.html) guide in the documentation and step-by-step [Tutorials](https://github.com/MadeInPierre/finalynx/tree/main/examples/tutorials). For additional details, checkout the full [API Reference](https://finalynx.readthedocs.io/en/latest/apidocs/index.html) or [ask a question](https://github.com/MadeInPierre/finalynx/discussions/new?category=q-a).

docs/_static/screenshot_demo_frameless.png

@@ -1,8 +1,6 @@
 import json
 import os
 from datetime import date
-from typing import Any
-from typing import Dict
 from typing import List
 from typing import Optional
 from typing import Tuple
@@ -13,19 +11,14 @@
 from finalynx import Dashboard
 from finalynx import Fetch
 from finalynx import Portfolio
-from finalynx.config import DEFAULT_CURRENCY
 from finalynx.config import get_active_theme as TH
 from finalynx.config import set_active_theme
+from finalynx.copilot.recommendations import render_recommendations
 from finalynx.fetch.source_base import SourceBase
 from finalynx.fetch.source_finary import SourceFinary
 from finalynx.portfolio.bucket import Bucket
 from finalynx.portfolio.envelope import Envelope
-from finalynx.portfolio.folder import Folder
-from finalynx.portfolio.folder import FolderDisplay
-from finalynx.portfolio.folder import SharedFolder
 from finalynx.portfolio.folder import Sidecar
-from finalynx.portfolio.node import Node
-from finalynx.portfolio.targets import Target
 from html2image import Html2Image
 from rich import inspect  # noqa F401
 from rich import pretty
@@ -261,7 +254,7 @@ def render_panels(self) -> Columns:
         panels: List[ConsoleRenderable] = [
             Text(" "),
             Panel(
-                self.render_recommendations(),
+                render_recommendations(self.portfolio, self.envelopes),
                 title="Recommendations",
                 padding=(1, 2),
                 expand=False,
@@ -288,80 +281,6 @@ def render_performance_report(self) -> Tree:
         tree.add(f"[{TH().TEXT}]Planned:  [bold][{TH().ACCENT}]{perf_ideal:.1f} %[/] / year")
         return tree
 
-    def render_recommendations(self) -> Tree:
-        """Sort lines with non-zero deltas by envelopes and display them as a summary of transfers to make.
-        Call either run() or initialize() first.
-        """
-        dict_envs: Dict[str, Any] = {}
-
-        # Guide the user to set envelopes if not already done
-        if not self.envelopes:
-            return Tree(
-                f"[dim {TH().TEXT}]"
-                "To activate recommendations, set\n"
-                "envelopes to your lines and give\n"
-                "them to Assistant (tutorial #11)"
-            )
-
-        # Find all folders with non-zero deltas and non-zero amounts (to avoid empty shared folders)
-        def _get_folders(node: Folder) -> List[Folder]:
-            found: List[Folder] = []
-            for child in node.children:
-                if isinstance(child, SharedFolder):
-                    if child.get_amount() > 0:
-                        found.append(child)
-                elif isinstance(child, Folder):
-                    if child.display == FolderDisplay.EXPANDED:
-                        found += _get_folders(child)
-                    else:
-                        found.append(child)
-            return found
-
-        # Check if a folder has non-zero deltas to be displayed in the recommendations
-        def _check_node(node: Node) -> bool:
-            return node.get_delta() != 0 and node.target.check() not in [
-                Target.RESULT_NONE,
-                Target.RESULT_OK,
-                Target.RESULT_TOLERATED,
-            ]
-
-        # Render each envelope of folder's parent with a custom style along with the
-        def _render_title(children: List[Any], name: str) -> Tuple[int, str]:
-            total_delta = round(sum([c.get_delta() for c in children]))
-            return total_delta, (
-                f"[{TH().DELTA_POS if total_delta > 0 else TH().DELTA_NEG}]"
-                f"{'+' if total_delta > 0 else ''}{total_delta} {DEFAULT_CURRENCY} "
-                f"[{TH().FOLDER_COLOR} {TH().FOLDER_STYLE}]{name}[/]"
-            )
-
-        # For each envelope, find all lines with non-zero deltas
-        for envelope in self.envelopes:
-            if lines := [line for line in envelope.lines if _check_node(line)]:
-                delta, title = _render_title(lines, envelope.name)
-                dict_envs[title] = (delta, lines)
-
-        # Render folders with non-zero deltas, classify them by parent name
-        if folders := [f for f in _get_folders(self.portfolio) if _check_node(f)]:
-            for parent_name in {f.parent.name for f in folders if f.parent}:
-                items = [f for f in folders if f.parent and f.parent.name == parent_name]
-                delta, title = _render_title(items, parent_name)
-                dict_envs[title] = (delta, items)
-
-        # Render the tree with folders containing lines with non-zero deltas (sorted by delta)
-        tree = Tree("Envelopes", hide_root=True, guide_style=TH().TREE_BRANCH)
-        dict_sorted = {k: v[1] for k, v in sorted(dict_envs.items(), key=lambda item: item[1][0])}  # type: ignore
-        for i_env, envelope_name in enumerate(dict_sorted):
-            node = tree.add(envelope_name)
-            for i_line, line in enumerate(dict_sorted[envelope_name]):
-                render = f"[{TH().TEXT}]{line._render_delta(children=dict_sorted[envelope_name])}{line._render_name()}"  # type: ignore
-                newline = bool(i_line == len(dict_sorted[envelope_name]) - 1 and i_env < len(dict_envs.keys()) - 1)
-                node.add(render + ("\n" if newline else ""))
-
-        # If no envelopes are displayed, show a nice message instead
-        if not tree.children:
-            tree.add("You're on track! 🎉")
-        return tree
-
     def dashboard(self) -> None:
         """Launch an interactive web dashboard! Call either run() or initialize() first."""
         console.log("Launching dashboard.")
@@ -421,9 +340,12 @@ def export_img(
         output_html = dashboard_console.export_html().replace("body {", f"body {{\n    zoom: {zoom};")
 
         # Convert the HTML to PNG
-        Html2Image(output_path=full_path).screenshot(html_str=output_html, save_as=file_name, size=size)
+        try:
+            Html2Image(output_path=full_path).screenshot(html_str=output_html, save_as=file_name, size=size)
+            console.print(f"Saved portfolio PNG to '{full_path + file_name}'")
+        except Exception as e:
+            console.log(f"[red][bold]Error:[/] Package html2image failed, skipping ({e})")
 
         # Restore theme and return the image path
         set_active_theme(previous_theme)
-        console.print(f"Saved portfolio PNG to '{full_path + file_name}'")
         return full_path + file_name

finalynx/assistant.py

@@ -0,0 +1,93 @@
+from typing import Any
+from typing import Dict
+from typing import List
+from typing import Tuple
+
+from finalynx.config import DEFAULT_CURRENCY
+from finalynx.config import get_active_theme as TH
+from finalynx.portfolio.envelope import Envelope
+from finalynx.portfolio.folder import Folder
+from finalynx.portfolio.folder import FolderDisplay
+from finalynx.portfolio.folder import Portfolio
+from finalynx.portfolio.folder import SharedFolder
+from finalynx.portfolio.node import Node
+from finalynx.portfolio.targets import Target
+from rich.tree import Tree
+
+
+# TODO Generate recommendations as a list of Transaction objects to make, then render them
+
+
+def render_recommendations(portfolio: Portfolio, envelopes: List[Envelope]) -> Tree:
+    """Sort lines with non-zero deltas by envelopes and display them as a summary of transfers to make.
+    Call either run() or initialize() first.
+    """
+    dict_envs: Dict[str, Any] = {}
+
+    # Guide the user to set envelopes if not already done
+    if not envelopes:
+        return Tree(
+            f"[dim {TH().TEXT}]"
+            "To activate recommendations, set\n"
+            "envelopes to your lines and give\n"
+            "them to Assistant (tutorial #11)"
+        )
+
+    # Find all folders with non-zero deltas and non-zero amounts (to avoid empty shared folders)
+    def _get_folders(node: Folder) -> List[Folder]:
+        found: List[Folder] = []
+        for child in node.children:
+            if isinstance(child, SharedFolder):
+                if child.get_amount() > 0:
+                    found.append(child)
+            elif isinstance(child, Folder):
+                if child.display == FolderDisplay.EXPANDED:
+                    found += _get_folders(child)
+                else:
+                    found.append(child)
+        return found
+
+    # Check if a folder has non-zero deltas to be displayed in the recommendations
+    def _check_node(node: Node) -> bool:
+        return node.get_delta() != 0 and node.target.check() not in [
+            Target.RESULT_NONE,
+            Target.RESULT_OK,
+            Target.RESULT_TOLERATED,
+        ]
+
+    # Render each envelope of folder's parent with a custom style along with the
+    def _render_title(children: List[Any], name: str) -> Tuple[int, str]:
+        total_delta = round(sum([c.get_delta() for c in children]))
+        return total_delta, (
+            f"[{TH().DELTA_POS if total_delta > 0 else TH().DELTA_NEG}]"
+            f"{'+' if total_delta > 0 else ''}{total_delta} {DEFAULT_CURRENCY} "
+            f"[{TH().FOLDER_COLOR} {TH().FOLDER_STYLE}]{name}[/]"
+        )
+
+    # For each envelope, find all lines with non-zero deltas
+    for envelope in envelopes:
+        if lines := [line for line in envelope.lines if _check_node(line)]:
+            delta, title = _render_title(lines, envelope.name)
+            dict_envs[title] = (delta, lines)
+
+    # Render folders with non-zero deltas, classify them by parent name
+    if folders := [f for f in _get_folders(portfolio) if _check_node(f)]:
+        for parent_name in {f.parent.name for f in folders if f.parent}:
+            items = [f for f in folders if f.parent and f.parent.name == parent_name]
+            delta, title = _render_title(items, parent_name)
+            dict_envs[title] = (delta, items)
+
+    # Render the tree with folders containing lines with non-zero deltas (sorted by delta)
+    tree = Tree("Envelopes", hide_root=True, guide_style=TH().TREE_BRANCH)
+    dict_sorted = {k: v[1] for k, v in sorted(dict_envs.items(), key=lambda item: item[1][0])}  # type: ignore
+    for i_env, envelope_name in enumerate(dict_sorted):
+        node = tree.add(envelope_name)
+        for i_line, line in enumerate(dict_sorted[envelope_name]):
+            render = f"[{TH().TEXT}]{line._render_delta(children=dict_sorted[envelope_name])}{line._render_name()}"  # type: ignore
+            newline = bool(i_line == len(dict_sorted[envelope_name]) - 1 and i_env < len(dict_envs.keys()) - 1)
+            node.add(render + ("\n" if newline else ""))
+
+    # If no envelopes are displayed, show a nice message instead
+    if not tree.children:
+        tree.add("You're on track! 🎉")
+    return tree