Merge branch 'main' into dev

Author: clstaudt

.github/workflows/pyinstaller-build.yml renamed to .github/workflows/flet-pack.yml

@@ -14,17 +14,17 @@ jobs:
         os: ["macos-latest", "windows-latest"]
 
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-python@v2
+    - uses: actions/checkout@main
+    - uses: actions/setup-python@main
       with:
         python-version: 3.10.7
     - run: pip install -r requirements.txt
     - run: pip install -r requirements_build.txt
     - run: pip install --no-dependencies -e .
-    - run: python scripts/build_app.py --one-file
+    - run: python scripts/pack_app.py
     # Optionally verify that it works (provided that it does not need user interaction)
     #- run: ./dist/your-code/your-code
-    - uses: actions/upload-artifact@v3
+    - uses: actions/upload-artifact@main
       with:
         name: Tuttle-${{ github.sha }}-${{ matrix.os }}
         path: dist/

.github/workflows/python-package.yml

@@ -19,9 +19,9 @@ jobs:
         python-version: ["3.8", "3.9", "3.10", "3.11"]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@main
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@main
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies

README.md

@@ -123,6 +123,13 @@ $ python app/app.py
 1. Requires [GTK](https://www.gtk.org).
 
 
+## Build
+
+To build an app bundle, run
+
+```shell
+python scripts/pack_app.py
+```
 
 
 ## Contributing

scripts/build_app.py

@@ -0,0 +1,62 @@
+from typing import Optional
+
+import sys
+from pathlib import Path
+import typer
+from loguru import logger
+import subprocess
+
+import tuttle
+
+app_path = "app/app.py"
+app_name = "Tuttle"
+icon_path = "app/assets/icon/macos/AppIcon.icns"
+
+# files to be added to the app bundle
+added_files = [
+    ("templates", "./templates"),
+    ("tuttle_tests/data", "./tuttle_tests/data"),
+]
+
+# options to be passed to flet pack
+pack_options = [
+    ("--name", app_name),
+    ("--icon", icon_path),
+    ("--product-name", app_name),
+    ("--product-version", tuttle.__version__),
+]
+
+if sys.platform.startswith("win"):
+    delimiter = ";"
+else:
+    delimiter = ":"
+
+added_data_options = []
+for src, dst in added_files:
+    added_data_options += ["--add-data", f"{src}{delimiter}{dst}"]
+pack_options_unpacked = [item for pair in pack_options for item in pair]
+
+
+def main(
+    install_dir: Optional[Path] = typer.Option(
+        None, "--install-dir", "-i", help="Where to install the app"
+    ),
+):
+    if install_dir:
+        logger.info(f"removing app from {install_dir}")
+        subprocess.call(["rm", "-rf", f"{install_dir}/Tuttle.app"], shell=False)
+
+    logger.info("building app")
+    pack_command = (
+        ["flet", "pack", app_path] + added_data_options + pack_options_unpacked
+    )
+    logger.info(f"calling flet with command: {' '.join(pack_command)}")
+    print(pack_command)
+    subprocess.call(
+        pack_command,
+        shell=False,
+    )
+
+
+if __name__ == "__main__":
+    typer.run(main)