Modernised icons and asset management

.github/workflows/buildpackage-mac.yml

@@ -13,14 +13,15 @@ jobs:
 
     strategy:
       matrix:
-        os: [macos-13,macos-14]
-        architecture: [x64]
-        python-version: ['3.11','3.13']
-        exclude:
-          - os: macos-13
-            python-version: '3.13'
-          - os: macos-14
+        include:
+          # build for Intel x64
+          - os: macos-15-intel
+            architecture: x64
             python-version: '3.11'
+          # build for Apple Silicon arm64
+          - os: macos-14
+            architecture: arm64
+            python-version: '3.13'
 
     steps:
     - name: Checkout
@@ -38,13 +39,17 @@ jobs:
         python setup.py build_ext --inplace
     - name: Make pyinstaller spec
       run: |
-        pyi-makespec --hidden-import="pkg_resources.py2_warn" -F --add-data images/\*:images --add-data \*.png:. --add-data \*.ico:. --name Pronterface -w -i P-face.icns pronterface.py
+        pyi-makespec --windowed --name "Pronterface" --target-architecture "${{ matrix.architecture == 'arm64' && 'arm64' || 'x86_64' }}" --add-data "printrun/assets:printrun/assets" --icon "./assets_raw/icons/pronterface.icns" pronterface.py
         # Edit spec file
-        export git_hash=$(git rev-parse --short "$GITHUB_SHA")
+        export GIT_HASH=$(git rev-parse --short "$GITHUB_SHA")
+        export VERSION="$(python3 -c 'import printrun.printcore as core; print(core.__version__)' 2>/dev/null)"
+        export YEAR=$(date +%Y)
         sed -i '' '$ s/.$//' Pronterface.spec
         cat >> Pronterface.spec <<EOL
         info_plist={
-            'CFBundleShortVersionString': '$git_hash',
+            'CFBundleVersion': '$GIT_HASH',
+            'CFBundleShortVersionString': "$VERSION",
+            'NSHumanReadableCopyright': "FOSS © $YEAR, GPL-3.0 licensed",
             'NSPrincipalClass': 'NSApplication',
             'NSAppleScriptEnabled': False,
             'NSAppSleepDisabled': True,

.github/workflows/buildpackage-win.yml

@@ -55,8 +55,8 @@ jobs:
 
     - name: Make pyinstaller spec
       run: |
-        pyi-makespec --hidden-import="pkg_resources.py2_warn" -F --name "Pronterface" --add-data "images/*;images" --add-data "*.png;." --add-data "*.ico;." -w -i pronterface.ico pronterface.py
-        pyi-makespec --hidden-import="pkg_resources.py2_warn" -F --name "Pronsole" --add-data "images/*;images" --add-data "*.png;." --add-data "*.ico;." -c -i pronsole.ico pronsole.py
+        pyi-makespec -F --name "Pronterface" --add-data "printrun/assets;printrun/assets" -w -i "./assets_raw/icons/pronterface.ico" pronterface.py
+        pyi-makespec -F --name "Pronsole" -c -i "./assets_raw/icons/pronsole.ico" pronsole.py
     - name: Make pyinstaller build
       run: |
         pyinstaller --clean Pronterface.spec -y

MANIFEST.in

@@ -1,7 +1,9 @@
 include COPYING
 include README.*
+include buildinstructions.md
+include release_windows.bat
 include requirements.txt
-include *.ico
-include *.icns
+include assets_raw/icons/*.png 
+recursive-include assets_raw *.ico *.icns *.desktop *.appdata.xml
 recursive-include locale *.pot *.po *.mo
 recursive-include printrun *.pyx *.c *.h

buildinstructions.md

@@ -1,8 +1,9 @@
 # Build instructions
 In general please follow the build instructions as described in [README.md](README.md). Here you will find a brief overview about what is needed to build your own development environment without further explanations.
-## Setup on OS X
+
+## Setup on macOS
 ### Prerequisites
-* install python 3.10
+* install supported python version (see [README.md](README.md))
 * install python extension compile environment, this is automatically done if you have xcode
 * install git
 ### Clone the repository
@@ -13,8 +14,8 @@ git pull
 ```
 ### Install and activate the virtual environment
 ```
-python3 -m venv v3
-. ./v3/bin/activate
+python3 -m venv venv
+. ./venv/bin/activate
 ```
 ### Install and update all required libraries
 ```
@@ -29,27 +30,11 @@ python setup.py build_ext --inplace
 `python pronterface.py`
 
 ### For packaging
-```
-pip install pyinstaller
-pyi-makespec --hidden-import="pkg_resources.py2_warn" -F --add-data images/\*:images --add-data \*.png:. --add-data \*.ico:. -w -i P-face.icns pronterface.py
-rm -rf dist
-sed -i '' '$ s/.$//' pronterface.spec
-cat >> pronterface.spec <<EOL
-,
-info_plist={
-    'NSPrincipalClass': 'NSApplication',
-    'NSAppleScriptEnabled': False,
-    'NSAppSleepDisabled': True,
-  },
-)
-EOL
-pyinstaller --clean pronterface.spec -y
-(optional) codesign -s identityname dist/pronterface.app --deep
-```
+Please find further informations about building a development environment and packaging in the script [release_macos.sh](release_macos.sh) where we implemented an automated build for macOS.
 
 ## Setup on Windows
 ### Prerequisites
-* install python 3.10
+* install supported python version (see [README.md](README.md))
 * install python extension compile environment, see https://wiki.python.org/moin/WindowsCompilers
 * install git
 ### Clone the repository
@@ -80,14 +65,7 @@ Please see remark for polygon3[^1]
 `python pronterface.py`
 
 ### For packaging
-```
-pip install pyinstaller
-pyi-makespec -F --add-data images/*;images --add-data *.png;. --add-data *.ico;. -w -i pronterface.ico pronterface.py
-pyinstaller --clean pronterface.spec -y
-```
-
-> [!TIP]
-> Please find further informations about building a development environment and packaging in script [release_windows.bat](release_windows.bat) where we implemented an automated build for windows.
+Please find further informations about building a development environment and packaging in the script [release_windows.bat](release_windows.bat) where we implemented an automated build for windows.
 
 ### Remark: