Merge pull request #13 from Adam-Color/Develop

Merge for 1.4.0

Author: Adam-Color

.gitignore

@@ -138,6 +138,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+.conda
 
 # Spyder project settings
 .spyderproject

README.md

@@ -1,4 +1,4 @@
-![version](https://img.shields.io/badge/Version-1.3.0-white.svg)
+![version](https://img.shields.io/badge/Version-1.4.0-white.svg)
 ![license](https://img.shields.io/badge/License-GPL%20v3-blue.svg)
 ![python](https://img.shields.io/badge/Python-3.12-green.svg)
 
@@ -15,20 +15,25 @@ This program tracks the runtime of a specified application, logging the duration
 
 ## Installation
 
-We now have proper installers for Mac OS and Windows!
-
-Find them [here](https://github.com/Adam-Color/AppUsageGUI/releases)
+To install, follow the instructions for your platform found here:
 
+[Windows](docs/install_windows.md) | [macOS](docs/install_macos.md)
 
 ## Contributing
 
 ### Contributions are welcome and needed! Here is a TODO list:
 
-* add integrations with professional applications
+* Add integrations with professional applications
 * Optimize everything
 * Add support for tracking more than one executable per session
+* Impliment a better way to filter out non-gui apps on macOS
 
 #### Version 2 ('v2-change-to-pyqt6' branch):
 
+> [!WARNING]
+> In **macOS**, PyQt6 conflicts with py-objc, leading to a broken venv.
+> As a result, v2 is not currently being worked on until this issue is fixed.
+
+* Merge and resolve changes from Develop into v2
 * Move to a single QT UI instead of multiple 'screens'
-* Add ways to analyze app usage data in the app
+* Add ways to analyze app usage data in the app

build.py

@@ -2,6 +2,7 @@
 import sys
 import shutil
 import subprocess
+import platform
 from src._version import __version__
 
 # Project details
@@ -25,23 +26,32 @@ def build_executable():
 
     icon_file = "src/core/resources/icon.ico" if os.name == 'nt' else "src/core/resources/icon.icns"
     print("Building the application...")
+    if sys.platform == 'darwin':
+        run_command('export PYTHONOPTIMIZE=1')
+        windows_only_1 = ""
+    else:
+        run_command('set PYTHONOPTIMIZE=1')
+        windows_only_1 = '--collect-all pywinauto'
     run_command(
-        f'{python_executable} -m PyInstaller --onefile --clean --name {PROJECT_NAME} '
+        f'{python_executable} -m PyInstaller -D --clean --name {PROJECT_NAME} '
+        f'--noconfirm '
         f'--windowed --clean '
         f'--add-data "src/core:core" '
         f'--add-data "{icon_file}:." '
         f'--collect-submodules core '
         f'--collect-all psutil '
-        f'--collect-all pynput '
         f'--collect-all tkinter '
+        f'--collect-all pynput '
+        f'--collect-all requests '
+        f'--collect-all PIL '
+        f'{windows_only_1} '
         f'--icon={icon_file} '
         f'--add-data "src/_version.py:." '
+        f'--add-data "src/_path.py:." '
+        f'--target-architecture {platform.machine()} '
         f'--debug=imports {ENTRY_POINT}'
     )
 
-
-
-
 def clean_up():
     """Remove build artifacts."""
     print("Cleaning up...")
@@ -50,7 +60,7 @@ def clean_up():
             shutil.rmtree(folder)
 
 def main():
-    print(f"Starting build process for {PROJECT_NAME}...")
+    print(f"Starting build process for {PROJECT_NAME} under {platform.machine()}...")
 
     build_executable()
     clean_up()

docs/install_macos.md

@@ -0,0 +1,17 @@
+## macOS Installation Steps:
+* download the macOS setup .dmg [here](https://github.com/Adam-Color/AppUsageGUI/releases/latest) (under the "assets" section)
+* double-click the .dmg to open it
+* agree to the [license](../LICENSE.txt)
+* drag the "AppUsageGUI" folder to the "Applications" folder
+
+## Running on macOS:
+>[!warning]
+>Due to Apple's restrictions when it comes to open source applications such as ours, workarounds are needed to get AppUsageGUI to run on macOS.
+
+If you encounter the error message saying the app was not opened, click "done", then go into your security settings and allow AppUsageGUI to run on your device
+
+Enter this in your terminal if AppUsageGUI still does not run:
+
+```shell
+xattr -dr com.apple.quarantine /Applications/AppUsageGUI/AppUsageGUI.app
+```

docs/install_windows.md

@@ -0,0 +1,5 @@
+## Windows Installation Steps:
+* download the windows setup .exe [here](https://github.com/Adam-Color/AppUsageGUI/releases/latest) (under the "assets" section)
+* double-click the setup .exe to open it
+* follow the instructions on screen
+* if the installer asks to replace a file that is already there, click "yes"

docs/release_template.md

@@ -0,0 +1,16 @@
+# AppUsageGUI v0.0.0
+
+To install, follow the instructions for your platform found here:
+
+[Windows](install_windows.md) | [macOS](install_macos.md)
+
+## What's Changed
+
+### Major Changes:
+* 
+
+### Minor Changes:
+* 
+
+### Patches:
+* 

installers/macos_installer.sh

@@ -1,4 +1,7 @@
 #!/bin/bash
 # This script is used to create the installer for the macOS version of the application
+app_version='1.4.0'
 
-create-dmg --volicon src/core/resources/icon.icns --volname AppUsageGUIsetup --window-pos 200 190 --window-size 800 400 --app-drop-link 600 185 --eula LICENSE.txt dist/AppUsageGUI_v1.3.0_macOS_arm64_setup.dmg dist/AppUsageGUI.app
+mv dist/AppUsageGUI.app dist/AppUsageGUI/
+
+create-dmg --volicon src/core/resources/icon.icns --volname AppUsageGUIsetup --window-pos 200 190 --window-size 800 400 --app-drop-link 600 185 --eula LICENSE.txt dist/AppUsageGUI_v${app_version}_macOS_arm64_setup.dmg dist/

installers/windows_installer.iss

@@ -2,11 +2,11 @@
 ; SEE THE DOCUMENTATION FOR DETAILS ON CREATING INNO SETUP SCRIPT FILES!
 
 #define MyAppName "AppUsageGUI"
-#define MyAppVersion "1.3.0"
+#define MyAppVersion "1.4.0"
 #define MyAppPublisher "Adam Blair-Smith"
 #define MyAppURL "https://github.com/Adam-Color/AppUsageGUI"
 #define MyAppExeName "AppUsageGUI.exe"
-#define MyInstallerName "AppUsageGUI_v1.3.0_WINDOWS_setup"
+#define MyInstallerName "AppUsageGUI_v1.4.0_WINDOWS_setup"
 
 [Setup]
 ; NOTE: The value of AppId uniquely identifies this application. Do not use the same AppId value in installers for other applications.
@@ -46,7 +46,8 @@ Name: "english"; MessagesFile: "compiler:Default.isl"
 Name: "desktopicon"; Description: "{cm:CreateDesktopIcon}"; GroupDescription: "{cm:AdditionalIcons}"; Flags: unchecked
 
 [Files]
-Source: "..\dist\{#MyAppExeName}"; DestDir: "{app}"; Flags: ignoreversion
+Source: "..\dist\{#MyAppName}\{#MyAppExeName}"; DestDir: "{app}"; Flags: ignoreversion
+Source: "..\dist\{#MyAppName}\_internal\*"; DestDir: "{app}\_internal"; Flags: ignoreversion recursesubdirs createallsubdirs
 Source: "..\src\core\resources\icon.ico"; DestDir: "{app}/src/core/resources"; Flags: ignoreversion
 ; NOTE: Don't use "Flags: ignoreversion" on any shared system files
 

requirements.txt

@@ -12,4 +12,5 @@ PyScreeze==1.0.1
 pytweening==1.2.0
 rubicon-objc==0.5.0
 pyinstaller
-requests==2.32.3
+requests==2.32.3
+pillow==11.2.1

src/_path.py

@@ -0,0 +1,11 @@
+import sys
+import os
+
+def resource_path(relative_path):
+    """ Get absolute path to resource, works for dev and for PyInstaller """
+    try:
+        # PyInstaller creates a temp folder and stores path in _MEIPASS
+        base_path = sys._MEIPASS
+    except Exception:
+        base_path = os.path.abspath(os.path.dirname(__file__))
+    return os.path.join(base_path, relative_path)

src/_version.py

@@ -1 +1 @@
-__version__ = "1.3.0"
+__version__ = "1.4.0"

src/core/gui_root.py

@@ -1,4 +1,6 @@
 import tkinter as tk
+import traceback
+import time
 
 from .logic_root import LogicRoot
 
@@ -17,7 +19,7 @@ def __init__(self, parent):
         self.parent = parent
 
         # Initialize LogicRoot
-        self.logic_controller = LogicRoot(self)
+        self.logic = LogicRoot(self)
 
         self.container = tk.Frame(self)
         self.container.pack(side="top", fill="both", expand=True)
@@ -35,7 +37,7 @@ def init_screens(self):
         # Pass the logic_controller when initializing screens
         for F in (MainWindow, SessionsWindow, SelectAppWindow, TrackerWindow, SaveWindow, CreateSessionWindow, SessionTotalWindow, TrackerSettingsWindow):
             page_name = F.__name__
-            frame = F(parent=self.container, controller=self, logic_controller=self.logic_controller)
+            frame = F(parent=self.container, controller=self, logic_controller=self.logic)
             self.frames[page_name] = frame
 
             frame.grid(row=0, column=0, sticky="nsew")
@@ -49,19 +51,18 @@ def show_frame(self, page_name):
     def reset_frames(self):
         try:
             # Stop trackers
-            if self.logic_controller.app_tracker:
-                self.logic_controller.app_tracker.reset()
+            if self.logic.app_tracker:
+                self.logic.app_tracker.reset()
 
-            if self.logic_controller.time_tracker:
-                self.logic_controller.time_tracker.reset()
+            if self.logic.time_tracker:
+                self.logic.time_tracker.reset()
 
-            if self.logic_controller.mouse_tracker:
-                self.logic_controller.mouse_tracker.stop()
+            if self.logic.mouse_tracker:
+                self.logic.mouse_tracker.stop()
 
             # Stop GUI threads
-            for frame_name, frame in self.frames.items():
-                if hasattr(frame, "stop_threads"):
-                    frame.stop_threads()
+            self.frames["TrackerWindow"].stop_threads()
+            self.frames["SessionTotalWindow"].stop_threads(wait=False)
 
             # Destroy frames
             for frame_name, frame in self.frames.items():
@@ -73,21 +74,26 @@ def reset_frames(self):
             self.init_screens()
 
         except Exception as e:
-            print(f"Crash in reset_frames(): {e}")
+            tk.messagebox.showerror("Error", f"Crash in reset_frames(): {str(traceback.format_exc())}")
 
     def on_close(self):
         """Handle cleanup and close the application."""
+
+        # Stop GUI threads
+        self.frames["TrackerWindow"].stop_threads()
+        self.frames["SessionTotalWindow"].stop_threads(wait=False)
+        
         # Stop the AppTracker thread
-        if self.logic_controller.app_tracker:
-            self.logic_controller.app_tracker.stop()
+        if self.logic.app_tracker:
+            self.logic.app_tracker.stop()
 
         # stop the TimeTracker thread
-        if self.logic_controller.time_tracker:
-            self.logic_controller.time_tracker.stop()
+        if self.logic.time_tracker:
+            self.logic.time_tracker.stop()
 
         # stop the MouseTracker thread
-        if self.logic_controller.mouse_tracker:
-            self.logic_controller.mouse_tracker.stop()
+        if self.logic.mouse_tracker:
+            self.logic.mouse_tracker.stop()
 
         # Destroy the root window
         self.parent.destroy()