Complete APP readme, package release script, final changes

The app tutorial has been written in depth, with accompanying images for illustration. A release script has been written by bundling the source code into a ZIP and generating the EXE using Pyinstaller. And that marks the end of v1!

Author: leoz0214

.gitignore

@@ -2,4 +2,5 @@
 testing/test_outputs/
 *.so
 docs/_*
-dist/
+dist/
+release/

APP.md

@@ -0,0 +1,82 @@
+"""Entire release creation - including source code and EXE."""
+import os
+import pathlib
+import shutil
+import subprocess
+
+
+FOLDER = pathlib.Path(__file__).parent
+RELEASE_FOLDER = FOLDER / "release"
+if RELEASE_FOLDER.is_dir():
+    shutil.rmtree(RELEASE_FOLDER)
+RELEASE_FOLDER.mkdir()
+
+CODE_PACKAGE_FOLDER = RELEASE_FOLDER / "code"
+CODE_PACKAGE_ZIP = RELEASE_FOLDER / "code"
+
+ICON = FOLDER / "src" / "gui" / "bin" / "icon.ico"
+START_SCRIPT = FOLDER / "run_app.py"
+
+PATHS = (
+    FOLDER / "src",
+    FOLDER / "src" / "gui"
+)
+BINARIES = {
+    FOLDER / "src" / "gui" / "cpp" / "conversion.so": "src/gui/cpp",
+    FOLDER / "src" / "gui" / "cpp" / "foreground.so": "src/gui/cpp",
+}
+ADDITIONAL_DATA = {
+    FOLDER / "src" / "gui" / "bin": "src/gui/bin/"
+}
+OUTPUT_EXE_NAME = RELEASE_FOLDER / "streetviewimagedownloader.exe"
+
+
+def package_code() -> None:
+    """Packages source, ready to run."""
+    CODE_PACKAGE_FOLDER.mkdir()
+    shutil.copy(START_SCRIPT, CODE_PACKAGE_FOLDER / START_SCRIPT.name)
+    # Copy source folder.
+    shutil.copytree(FOLDER / "src", CODE_PACKAGE_FOLDER / "src")
+    # Delete all pycaches.
+    for path in (CODE_PACKAGE_FOLDER / "src").rglob("__pycache__"):
+        shutil.rmtree(path)
+    # Make zip file.
+    shutil.make_archive(CODE_PACKAGE_ZIP, "zip", CODE_PACKAGE_FOLDER)
+    # Delete copied source folder.
+    shutil.rmtree(CODE_PACKAGE_FOLDER)
+
+
+def package_exe() -> None:
+    """Packages standalone EXE, ready to run."""
+    # Build command parts.
+    command_parts = [
+        "pyinstaller", str(START_SCRIPT), "--noconfirm", "--onefile",
+        "--windowed",  "--icon", str(ICON)]
+    for binary_src, binary_dest in BINARIES.items():
+        command_parts.append("--add-binary")
+        command_parts.append(f"{binary_src};{binary_dest}")
+    for path in PATHS:
+        command_parts.append("--paths")
+        command_parts.append(str(path))
+    for add_data_src, add_data_dest in ADDITIONAL_DATA.items():
+        command_parts.append("--add-data")
+        command_parts.append(f"{add_data_src};{add_data_dest}")
+    # Run Pyinstaller.
+    os.chdir(RELEASE_FOLDER)
+    subprocess.run(command_parts)
+    # Renames output EXE.
+    output_exe = RELEASE_FOLDER / "dist" / f"{START_SCRIPT.stem}.exe"
+    output_exe.rename(OUTPUT_EXE_NAME)
+    # Deletes Pyinstaller files and folders.
+    (RELEASE_FOLDER / "dist").rmdir()
+    shutil.rmtree(RELEASE_FOLDER / "build")
+    (RELEASE_FOLDER / f"{START_SCRIPT.stem}.spec").unlink(True)
+
+
+def main() -> None:
+    package_code()
+    package_exe()
+
+
+if __name__ == "__main__":
+    main()

app_images/batch_add_panorama_id.PNG

@@ -0,0 +1,18 @@
+"""Runs the Street View Image Download app."""
+import pathlib
+import sys
+
+
+if hasattr(sys, "_MEIPASS"):
+    FOLDER = pathlib.Path(sys._MEIPASS) / "src"
+else:
+    FOLDER = pathlib.Path(__file__).parent / "src"
+    
+sys.path.append(str(FOLDER))
+sys.path.append(str(FOLDER / "gui"))
+
+from gui.main import main
+
+
+if __name__ == "__main__":
+    main()

app_images/batch_after_adding.PNG

@@ -3,8 +3,10 @@
 from ctypes import windll
 
 
-sys.path.append(str(pathlib.Path(__file__).parent.parent))
-sys.path.append(str(pathlib.Path(__file__).parent))
+if hasattr(sys, "_MEIPASS"):
+    sys.path.append(f"{sys._MEIPASS}/src") 
+else:
+    sys.path.append(str(pathlib.Path(__file__).parent.parent))
 
 # Make GUI DPI aware - significant GUI quality improvement.
 windll.shcore.SetProcessDpiAwareness(True)

app_images/batch_after_settings.PNG

@@ -1,19 +1,25 @@
 """Utilities for the GUI."""
 import ctypes
 import pathlib
+import sys
 import tkinter as tk
 from tkinter.font import Font
 
 import pyglet
 
 
-BIN_FOLDER = pathlib.Path(__file__).parent / "bin"
-CPP_FOLDER = pathlib.Path(__file__).parent / "cpp"
+if hasattr(sys, "_MEIPASS"):
+    GUI_FOLDER = pathlib.Path(sys._MEIPASS) / "src" / "gui"
+else:
+    GUI_FOLDER = pathlib.Path(__file__).parent
+BIN_FOLDER = GUI_FOLDER / "bin"
+CPP_FOLDER = GUI_FOLDER / "cpp"
 CPP_FOREGROUND_PID_LIBRARY = CPP_FOLDER / "foreground.so"
 CPP_CONVERSION_LIBRARY = CPP_FOLDER / "conversion.so"
 
 # Load Inter font downloaded online.
 pyglet.font.add_file(str(BIN_FOLDER / "Inter.ttf"))
+ICON_FILE = BIN_FOLDER / "icon.ico"
 
 
 RED = "#ff0000"

app_images/batch_blank.PNG

@@ -9,7 +9,7 @@
 import panorama_id
 import rendering
 import url
-from _utils import inter, BUTTON_COLOURS, bool_to_state
+from _utils import inter, BUTTON_COLOURS, bool_to_state, ICON_FILE
 
 
 TITLE = "Street View Image Downloader"
@@ -100,6 +100,7 @@ def __init__(self, master: MainMenu) -> None:
 def main() -> None:
     """Main procedure of the program."""
     root = tk.Tk()
+    root.iconbitmap(ICON_FILE)
     main_menu = MainMenu(root)
     main_menu.pack()
     root.mainloop()