installer script & template packaging

Author: clstaudt

app/Tuttle.py

@@ -4,6 +4,7 @@
 from textwrap import dedent
 from pathlib import Path
 import webbrowser
+import pkgutil
 
 import flet
 from flet import (
@@ -90,13 +91,60 @@ def __init__(
     def update(self):
         super().update()
 
-    def add_demo_data(self, event):
+    def on_click_load_demo_data(self, event):
         """Install the demo data on button click."""
         demo.add_demo_data(self.app.con)
         self.main_column.controls.clear()
         self.main_column.controls.append(
             Text("Demo data installed ☑️"),
         )
+
+        logger.info("Demo data installed")
+        self.app.snackbar_message("Demo data installed")
+        self.update()
+
+        self.main_column.controls.append(
+            views.make_card(
+                [
+                    Text(
+                        dedent(
+                            """
+                            2. Navigate the menu on the left to explore the demo data.
+                            """
+                        )
+                    )
+                ]
+            )
+        )
+
+        self.main_column.controls.append(
+            views.make_card(
+                [
+                    Text(
+                        dedent(
+                            """
+                            3. Navigate to the "Invoicing" page to generate some invoices.
+                            """
+                        )
+                    )
+                ]
+            )
+        )
+
+        self.main_column.controls.append(
+            views.make_card(
+                [
+                    Text(
+                        dedent(
+                            """
+                            4. Please use the help menu on the top right to tell us about issues or suggestions.
+                            """
+                        )
+                    )
+                ]
+            )
+        )
+
         self.update()
 
     def build(self):
@@ -125,7 +173,7 @@ def build(self):
                         ElevatedButton(
                             "Install demo data",
                             icon=icons.TOYS,
-                            on_click=self.add_demo_data,
+                            on_click=self.on_click_load_demo_data,
                         ),
                     ]
                 ),
@@ -247,18 +295,27 @@ def on_click_generate_invoices(self, event):
             f"generating invoice and timesheet for {self.project_select.value}"
         )
         logger.info("Generate invoices clicked")
-        if not self.calendar_file_path:
+        if (self.calendar_file_path is None) and (self.calendar_data is None):
             self.app.snackbar_message(f"Please select a calendar file")
             logger.error("No calendar file selected!")
             return
         try:
-            self.app.con.billing(
-                project_tags=[self.project_select.value],
-                period_start=str(self.date_from_select.get_date()),
-                period_end=str(self.date_to_select.get_date()),
-                timetracking_method="file_calendar",
-                calendar_file_path=self.calendar_file_path,
-            )
+            if self.calendar_file_path:
+                self.app.con.billing(
+                    project_tags=[self.project_select.value],
+                    period_start=str(self.date_from_select.get_date()),
+                    period_end=str(self.date_to_select.get_date()),
+                    timetracking_method="file_calendar",
+                    calendar_file_path=self.calendar_file_path,
+                )
+            elif self.calendar_data:
+                self.app.con.billing(
+                    project_tags=[self.project_select.value],
+                    period_start=str(self.date_from_select.get_date()),
+                    period_end=str(self.date_to_select.get_date()),
+                    timetracking_method="file_calendar",
+                    calendar_file_content=self.calendar_data,
+                )
             self.app.snackbar_message(
                 f"created invoice and timesheet for {self.project_select.value} - open the invoice folder to see the result"
             )
@@ -285,12 +342,12 @@ def on_click_open_invoice_folder(self, event):
 
     def on_click_load_demo_calendar(self, event):
         """Load the demo calendar file."""
-        self.calendar_file_path = Path(__file__).parent.parent / Path(
-            "tuttle_tests/data/TuttleDemo-TimeTracking.ics"
-        )
-        self.app.snackbar_message(
-            f"Loaded demo calendar file: {self.calendar_file_path}"
+        self.calendar_data = pkgutil.get_data(
+            "tuttle_tests", "data/TuttleDemo-TimeTracking.ics"
         )
+        assert len(self.calendar_data) > 0
+        logger.info(f"Loaded demo calendar file")
+        self.app.snackbar_message(f"Loaded demo calendar file")
 
     def update_content(self):
         super().update_content()

requirements_dev.txt

@@ -5,3 +5,4 @@ black
 nbdime
 pre-commit
 pyinstaller
+typer

scripts/build_app.py

@@ -1,25 +1,33 @@
+from typing import Optional
+
 import os
 import sys
 import subprocess
-
+import typer
+from pathlib import Path
 from loguru import logger
 
+
 added_files = [
-    ("tuttle_tests/data", "demo_data"),
-    ("templates", "templates"),
+    ("tuttle_tests/data", "./tuttle_tests/data"),
+    ("templates", "./templates"),
 ]
 
 added_data_options = [f"--add-data={src}:{dst}" for src, dst in added_files]
 
 
-def build_macos():
+def build_macos(
+    one_file: bool,
+):
     pyinstaller_options = [
         "--noconfirm",
         "--windowed",
         "--clean",
-        "--onefile",
-        # "--onedir",
     ]
+    if one_file:
+        pyinstaller_options += ["--onefile"]
+    else:
+        pyinstaller_options += ["--onedir"]
 
     options = pyinstaller_options + added_data_options
 
@@ -30,15 +38,20 @@ def build_macos():
     )
 
 
-def build_linux():
+def build_linux(
+    one_file: bool,
+):
     pyinstaller_options = [
         "--noconfirm",
         "--windowed",
         "--clean",
-        "--onefile",
-        # "--onedir",
     ]
 
+    if one_file:
+        pyinstaller_options += ["--onefile"]
+    else:
+        pyinstaller_options += ["--onedir"]
+
     options = pyinstaller_options + added_data_options
 
     logger.info(f"calling pyinstaller with options: {' '.join(options)}")
@@ -48,15 +61,21 @@ def build_linux():
     )
 
 
-def build_windows():
+def build_windows(
+    one_file: bool,
+):
     pyinstaller_options = [
         "--noconfirm",
         "--windowed",
         "--clean",
         "--onefile",
-        # "--onedir",
     ]
 
+    if one_file:
+        pyinstaller_options += ["--onefile"]
+    else:
+        pyinstaller_options += ["--onedir"]
+
     options = pyinstaller_options + added_data_options
 
     logger.info(f"calling pyinstaller with options: {' '.join(options)}")
@@ -66,24 +85,44 @@ def build_windows():
     )
 
 
-def main():
+def main(
+    install_dir: Optional[Path] = typer.Option(
+        None, "--install-dir", "-i", help="Where to install the app"
+    ),
+    one_file: bool = typer.Option(
+        False, "--one-file", "-f", help="Build a single file executable"
+    ),
+):
+    if install_dir:
+        logger.info(f"removing app from {install_dir}")
+        subprocess.call(["rm", "-rf", f"{install_dir}/Tuttle.app"], shell=False)
+
     # which operating system?
     if sys.platform.startswith("linux"):
         logger.info("building for Linux")
-        build_linux()
+        build_linux(
+            one_file=one_file,
+        )
     elif sys.platform.startswith("darwin"):
         logger.info("building for macOS")
-        build_macos()
+        build_macos(
+            one_file=one_file,
+        )
     elif sys.platform.startswith("win"):
         logger.info("building for Windows")
-        build_windows()
+        build_windows(
+            one_file=one_file,
+        )
     else:
         raise RuntimeError("Unsupported operating system")
 
+    if install_dir:
+        logger.info(f"installing to {install_dir}")
+        subprocess.call(
+            ["cp", "-r", "dist/Tuttle.app", install_dir],
+            shell=False,
+        )
 
-if __name__ == "__main__":
-    main()
 
-# os.system(
-#     "pyinstaller app/Tuttle.py --onefile --noconsole --noconfirm --add-data 'tuttle_tests/data/TuttleDemo-TimeTracking.ics:.'"
-# )
+if __name__ == "__main__":
+    typer.run(main)

tuttle/controller.py

@@ -213,6 +213,7 @@ def billing(
         period_end=None,
         timetracking_method="cloud_calendar",
         calendar_file_path=None,
+        calendar_file_content=None,
     ):
         """Generate time sheets and invoices for a given period"""
         out_dir = self.home / self.preferences.invoice_dir
@@ -224,10 +225,20 @@ def billing(
                 name="TimeTracking",
             )
         elif timetracking_method == "file_calendar":
-            timetracking_calendar = calendar.FileCalendar(
-                path=calendar_file_path,
-                name=calendar_file_path.stem,
-            )
+            if calendar_file_path:
+                timetracking_calendar = calendar.FileCalendar(
+                    path=calendar_file_path,
+                    name=calendar_file_path.stem,
+                )
+            elif calendar_file_content:
+                timetracking_calendar = calendar.FileCalendar(
+                    content=calendar_file_content,
+                    name="TimeTracking",
+                )
+            else:
+                raise ValueError(
+                    "either calendar_file_path or calendar_file_content required"
+                )
             if timetracking_calendar.to_data().empty:
                 raise ValueError(
                     f"empty calendar loaded from file {calendar_file_path}"
@@ -246,25 +257,35 @@ def billing(
                 period_end=period_end,
                 item_description=project.title,
             )
-            rendering.render_timesheet(
-                user=self.user,
-                timesheet=timesheet,
-                style="anvil",
-                document_format="pdf",
-                out_dir=out_dir,
-            )
+            logger.info(f"✅ timesheet generated for {project.title}")
+            try:
+                rendering.render_timesheet(
+                    user=self.user,
+                    timesheet=timesheet,
+                    style="anvil",
+                    document_format="pdf",
+                    out_dir=out_dir,
+                )
+            except Exception as ex:
+                logger.error(f"❌ Error rendering timesheet for {project.title}: {ex}")
+                logger.exception(ex)
             logger.info(f"generating invoice for {project.title}")
             invoice = invoicing.generate_invoice(
                 timesheets=[timesheet],
                 contract=project.contract,
                 date=datetime.date.today(),
                 counter=(i + 1),
             )
-            rendering.render_invoice(
-                user=self.user,
-                invoice=invoice,
-                style="anvil",
-                document_format="pdf",
-                out_dir=out_dir,
-            )
             logger.info(f"✅ created invoice for {project.title}")
+            try:
+                rendering.render_invoice(
+                    user=self.user,
+                    invoice=invoice,
+                    style="anvil",
+                    document_format="pdf",
+                    out_dir=out_dir,
+                )
+                logger.info(f"✅ rendered invoice for {project.title}")
+            except Exception as ex:
+                logger.error(f"❌ Error rendering invoice for {project.title}: {ex}")
+                logger.exception(ex)

tuttle/rendering.py

@@ -8,15 +8,17 @@
 from babel.numbers import format_currency
 import pandas
 import pdfkit
+from loguru import logger
 
 from .model import User, Invoice, Timesheet, Project
 from .view import Timeline
 
 
 def get_template_path(template_name) -> str:
     """Get the path to an HTML template by name"""
-    module_path = Path(__file__).parent.resolve()
-    template_path = module_path / Path(f"../templates/{template_name}")
+    app_dir = Path(__file__).parent.parent.resolve()
+    template_path = app_dir / Path(f"templates/{template_name}")
+    logger.info(f"Template path: {template_path}")
     return template_path