Add GitHub workflows for packaging Tkinter version and PyInstaller version; update .gitignore and pyproject.toml; refactor sound file paths in blackboard.py and familiada.py

Author: zamkorus

.github/workflows/pinstaltkinter.yaml

@@ -0,0 +1,43 @@
+name: Package Tkinter version of Familiada app
+
+on:
+  push:
+    tags:
+      - 'tkinter_v*' # Push events with a tag that starts with 'tkinter_v'
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6.0.2
+      
+      - name: Package Application using Cythinst64
+        uses: PlohnenSoftware/Cythinst64@v2.2
+        with:
+          path: src
+          zip_name: familiada.zip
+          zip_paths: |
+            src/dist/windows
+            dane.csv
+
+      # Step to upload the zipped folder as a workflow artifact
+      - name: Upload artifact
+        uses: actions/upload-artifact@v7.0.1
+        with:
+          name: familiada-tkinter
+          path: familiada.zip
+          if-no-files-found: error
+
+      # Step to create a release and upload the zipped folder as an asset
+      - name: Create Release
+        if: startsWith(github.ref, 'refs/tags/tkinter_v')
+        id: create_release
+        uses: softprops/action-gh-release@v3.0.0
+        with:
+          files: familiada.zip
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/pyinstaller.yml

@@ -0,0 +1,43 @@
+name: Package Familiada App with Pyinstaller
+
+on:
+  push:
+    tags:
+      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6.0.2
+      - name: Package Application using Cythinst64
+        uses: PlohnenSoftware/Cythinst64@v2.2
+        with:
+          path: src
+          cython_out: prec
+          zip_name: familiada.zip
+          zip_paths: |
+            src/dist/windows
+            dane.csv
+
+      # Step to upload the zipped folder as a workflow artifact
+      - name: Upload artifact
+        uses: actions/upload-artifact@v7.0.1
+        with:
+          name: familiada
+          path: familiada.zip
+          if-no-files-found: error
+
+      # Step to create a release and upload the zipped folder as an asset
+      - name: Create Release
+        if: startsWith(github.ref, 'refs/tags/v')
+        id: create_release
+        uses: softprops/action-gh-release@v3.0.0
+        with:
+          files: familiada.zip
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,4 +1,8 @@
+ve
 venv
+.venv
 __pycache__
 *.pyc
-*.spec
+stare.py
+build
+*.exe

pyproject.toml

@@ -1,2 +1,13 @@
+[project]
+name = "Familiada"
+version = "1.1.1"
+description = "Tkinter legacy release of the Familiada game."
+readme = "README.md"
+requires-python = "==3.13.*"
+dependencies = [
+    "pygame>=2.6.1",
+    "setuptools[core]>=82.0.1",
+]
+
 [tool.black]
-line-length = 200
+line-length = 200

src/Familiada.spec

@@ -0,0 +1,38 @@
+# -*- mode: python ; coding: utf-8 -*-
+
+
+a = Analysis(
+    ['familiada.py'],
+    pathex=[],
+    binaries=[],
+    datas=[('../sfx', 'sfx'), ('../familiada.ico', './'), ('../familiada.ttf', './'), ('../dane.csv', './')],
+    hiddenimports=[],
+    hookspath=[],
+    hooksconfig={},
+    runtime_hooks=[],
+    excludes=[],
+    noarchive=False,
+)
+pyz = PYZ(a.pure)
+
+exe = EXE(
+    pyz,
+    a.scripts,
+    a.binaries,
+    a.datas,
+    [],
+    name='Familiada',
+    debug=False,
+    bootloader_ignore_signals=False,
+    strip=False,
+    upx=True,
+    upx_exclude=[],
+    runtime_tmpdir=None,
+    console=False,
+    disable_windowed_traceback=False,
+    argv_emulation=False,
+    target_arch=None,
+    codesign_identity=None,
+    entitlements_file=None,
+    icon=['..\\familiada.ico'],
+)

src/blackboard.py

@@ -1,18 +1,30 @@
-import pygame
+import pygame,sys
 from math import floor
 from threading import Timer as Delay
+from os import path, getcwd
 
 
+if getattr(sys, "frozen", False):
+    application_path = path.dirname(path.abspath(__file__))
+    CWD_PATH = getcwd()
+elif __file__:
+    application_path = path.abspath("./")
+    CWD_PATH = application_path
+
+
+def res_path(relative_path):
+    return path.join(application_path, relative_path)
+
 # Import pygame SFX
 pygame.mixer.init()
-correct_sound = pygame.mixer.Sound("sfx/correct.wav")
-wrong_sound = pygame.mixer.Sound("sfx/incorrect.wav")
-dubel_sound = pygame.mixer.Sound("sfx/dubel.wav")
-bravo_sound = pygame.mixer.Sound("sfx/bravo.wav")
-write_sound = pygame.mixer.Sound("sfx/write.wav")
-round_sound = pygame.mixer.Sound("sfx/round_sound.wav")
-ending_music = pygame.mixer.Sound("sfx/final_ending.flac")
-intro_music = pygame.mixer.Sound("sfx/show_music.flac")
+correct_sound = pygame.mixer.Sound(res_path("sfx/correct.wav"))
+wrong_sound = pygame.mixer.Sound(res_path("sfx/incorrect.wav"))
+dubel_sound = pygame.mixer.Sound(res_path("sfx/dubel.wav"))
+bravo_sound = pygame.mixer.Sound(res_path("sfx/bravo.wav"))
+write_sound = pygame.mixer.Sound(res_path("sfx/write.wav"))
+round_sound = pygame.mixer.Sound(res_path("sfx/round_sound.wav"))
+ending_music = pygame.mixer.Sound(res_path("sfx/final_ending.flac"))
+intro_music = pygame.mixer.Sound(res_path("sfx/show_music.flac"))
 
 
 class Blackboard:

src/familiada.py

@@ -1,10 +1,9 @@
 import pygame
-import sys
+from sys import exit
 import tkinter
-import os
 from tkinter import messagebox, ttk, filedialog
 from blackboard import Blackboard as Bb
-from blackboard import dubel_sound, bravo_sound, round_sound, intro_music, ending_music
+from blackboard import dubel_sound, bravo_sound, round_sound, intro_music, ending_music, res_path, CWD_PATH
 
 # The program provides a graphical interface for the game Familiada.
 
@@ -21,24 +20,20 @@ def exit_app(tkwindow):
     tkwindow.destroy()
     pygame.display.quit()
     pygame.quit()
-    sys.exit()
+    exit()
 
 
 def terminate_error(error_description):
     if messagebox.showerror("FAMILIADA ERROR", error_description):
-        sys.exit()
-
+        exit()
 
 # Initialize the main game object
 game1 = Bb(20)
-
-# Read data from the disk
-current_dir = os.path.dirname(os.path.abspath(__file__))
 # lepiej zrobić pulpit na start, do finalnej wersji bo jak sie d exe spakuje to wywala do jakiegoś folderu temp,
 # gdzie jest interpreter pythona przenosny z Pyinstallera 
 # current_dir=os.path.join(os.path.join(os.environ['USERPROFILE']), 'Desktop')
 
-filename = filedialog.askopenfilename(initialdir=current_dir, title="Wybierz plik z danymi", filetypes=(("csv files", "*.csv"), ("all files", "*.*")))
+filename = filedialog.askopenfilename(initialdir=CWD_PATH, title="Wybierz plik z danymi", filetypes=(("csv files", "*.csv"), ("all files", "*.*")))
 
 if filename == "":
     terminate_error("Nie wybrano pliku")
@@ -102,13 +97,13 @@ def terminate_error(error_description):
 pygame.init()
 surface = pygame.display.set_mode((800, 600), pygame.RESIZABLE)
 pygame.display.set_caption("Familiada")
-programIcon = pygame.image.load("familiada.ico")
+programIcon = pygame.image.load(res_path("familiada.ico"))
 pygame.display.set_icon(programIcon)
 
 # Create the second window
 window1 = tkinter.Tk()
 window1.title("Familiada - reżyserka")
-window1.iconbitmap("familiada.ico")
+window1.iconbitmap(res_path("familiada.ico"))
 window1.geometry("650x400")
 style = ttk.Style(window1)
 window1.protocol("WM_DELETE_WINDOW", lambda: exit_app(window1))
@@ -234,7 +229,7 @@ def terminate_error(error_description):
     font_height = max(round(block_height * 0.75), 2)
 
     # Set the font
-    myfont = pygame.font.Font("familiada.ttf", font_height)
+    myfont = pygame.font.Font(res_path("familiada.ttf"), font_height)
 
     # Draw black rectangles & letters on the surface.
     for i in range(10):
@@ -261,4 +256,4 @@ def terminate_error(error_description):
 
     # Quit the game if the window is closed
     except pygame.error:
-        sys.exit()
+        exit()