bundle wkhtml binary for macOS app

Author: clstaudt

scripts/build_app.py

@@ -13,14 +13,10 @@
     ("templates", "./templates"),
 ]
 
-if sys.platform.startswith("win"):
-    added_data_options = [f"--add-data={src};{dst}" for src, dst in added_files]
-else:
-    added_data_options = [f"--add-data={src}:{dst}" for src, dst in added_files]
-
 
 def build_macos(
     one_file: bool,
+    bundle_third_party: bool,
 ):
     pyinstaller_options = [
         "--noconfirm",
@@ -32,7 +28,19 @@ def build_macos(
     else:
         pyinstaller_options += ["--onedir"]
 
-    options = pyinstaller_options + added_data_options
+    if bundle_third_party:
+        added_binaries = [
+            ("/usr/local/bin/wkhtmltopdf", "."),
+        ]
+        added_binary_options = [
+            f"--add-binary={src}:{dst}" for src, dst in added_binaries
+        ]
+    else:
+        added_binary_options = []
+
+    added_data_options = [f"--add-data={src}:{dst}" for src, dst in added_files]
+
+    options = pyinstaller_options + added_data_options + added_binary_options
 
     logger.info(f"calling pyinstaller with options: {' '.join(options)}")
     subprocess.call(
@@ -55,6 +63,8 @@ def build_linux(
     else:
         pyinstaller_options += ["--onedir"]
 
+    added_data_options = [f"--add-data={src}:{dst}" for src, dst in added_files]
+
     options = pyinstaller_options + added_data_options
 
     logger.info(f"calling pyinstaller with options: {' '.join(options)}")
@@ -79,6 +89,8 @@ def build_windows(
     else:
         pyinstaller_options += ["--onedir"]
 
+    added_data_options = [f"--add-data={src};{dst}" for src, dst in added_files]
+
     options = pyinstaller_options + added_data_options
 
     logger.info(f"calling pyinstaller with options: {' '.join(options)}")
@@ -95,6 +107,9 @@ def main(
     one_file: bool = typer.Option(
         False, "--one-file", "-f", help="Build a single file executable"
     ),
+    bundle_third_party: bool = typer.Option(
+        True, "--bundle-third-party", "-b", help="Bundle third party libraries"
+    ),
 ):
     if install_dir:
         logger.info(f"removing app from {install_dir}")
@@ -110,6 +125,7 @@ def main(
         logger.info("building for macOS")
         build_macos(
             one_file=one_file,
+            bundle_third_party=bundle_third_party,
         )
     elif sys.platform.startswith("win"):
         logger.info("building for Windows")

tuttle/rendering.py

@@ -1,15 +1,22 @@
 """Document rendering."""
 
+import os
+import sys
 from pathlib import Path
 import shutil
 import glob
 
 import jinja2
 from babel.numbers import format_currency
 import pandas
-import pdfkit
 from loguru import logger
 
+# pdfkit needs wkhtmltopdf to be installed
+if getattr(sys, "frozen", False):
+    os.environ["PATH"] = sys._MEIPASS + os.pathsep + os.environ["PATH"]
+import pdfkit
+
+
 from .model import User, Invoice, Timesheet, Project
 from .view import Timeline