Pyside

.github/workflows/build.yml

@@ -1,85 +1,171 @@
-name: Build with pyinstaller
+name: Build TiLiA
 
 on:
   workflow_dispatch:
   push:
     tags:
-      - 'v*'
+      - "v*"
 
 jobs:
   build:
-    name: Build with pyinstaller
+    name: Build with Nuitka
+    continue-on-error: true
     runs-on: ${{ matrix.os }}
+    permissions:
+      contents: read
+    outputs:
+      linux-build: ${{ steps.set-path.outputs.path }}
     strategy:
       matrix:
-        include:
-          - os: windows-latest
-            CMD_BUILD: pyinstaller tilia.spec
-            OUT_FILE_OS: win
-            OUT_FILE_EXTENSION: .exe
-            ASSET_MIME: application/vnd.microsoft.portable-executable
-
-          - os: macos-13
-            CMD_BUILD: >
-              pyinstaller tilia.spec &&
-              cd dist &&
-              mv tilia-$APP_VERSION-mac.app tilia-$APP_VERSION-mac-intel.app &&
-              zip -r9 tilia-$APP_VERSION-mac-intel.zip tilia-$APP_VERSION-mac-intel.app
-            OUT_FILE_OS: mac-intel
-            OUT_FILE_EXTENSION: .zip
-            ASSET_MIME: application/zip
-
-          - os: macos-14
-            CMD_BUILD: >
-              pyinstaller tilia.spec &&
-              cd dist &&
-              mv tilia-$APP_VERSION-mac.app tilia-$APP_VERSION-mac-silicon.app &&
-              zip -r9 tilia-$APP_VERSION-mac-silicon.zip tilia-$APP_VERSION-mac-silicon.app
-            OUT_FILE_OS: mac-silicon
-            OUT_FILE_EXTENSION: .zip
-            ASSET_MIME: application/zip
-
-          - os: ubuntu-latest
-            CMD_BUILD: >
-              pyinstaller tilia.spec
-            OUT_FILE_OS: linux
-            OUT_FILE_EXTENSION:
-            ASSET_MIME: application/octet-stream
+        os: [
+          macos-latest,
+          macos-15-intel,
+          ubuntu-22.04,
+          windows-latest
+          ]
+    env:
+      QT_DEBUG_PLUGINS: 1
+      QT_QPA_PLATFORM: offscreen
 
     steps:
-      - uses: actions/checkout@v4
-
-      - name: Extract package version
-        id: extract_version
-        shell: pwsh
-        run: |
-          $version = (Select-String '^version =' setup.cfg).Line -split ' = ' | Select-Object -Last 1
-          echo "APP_VERSION=$version" | Out-File -FilePath $env:GITHUB_ENV -Append
-
-      - name: Set output file name
-        shell: pwsh
-        run: |
-          $out_file_name = "tilia-${{env.APP_VERSION}}-${{matrix.OUT_FILE_OS}}${{matrix.OUT_FILE_EXTENSION}}"
-          echo "OUT_FILE_NAME=$out_file_name" | Out-File -FilePath $env:GITHUB_ENV -Append
+      - uses: actions/checkout@v6
 
       - name: Set up Python 3.11
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: 3.11
-          cache: 'pip'
+          cache: "pip"
+
+      - name: Setup additional Linux dependencies
+        if: runner.os == 'Linux'
+        run: |
+          chmod +x ./scripts/linux-setup.sh
+          ./scripts/linux-setup.sh
+
+      - name: Remove problematic brew libs (see Nuitka/Nuitka#2853)
+        if: runner.os == 'macOS' && runner.arch != 'ARM64'
+        run: |
+          brew remove --force --ignore-dependencies openssl@3
+          brew cleanup openssl@3
 
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip setuptools wheel
-          pip install -e .
-          pip install pyinstaller
+          python -m pip install --upgrade pip
+          pip install -e . --group build
 
       - name: Build executable
+        id: build-exe
+        shell: bash
+        run: |
+          echo "python scripts/deploy.py ${{github.ref_name}} ${{matrix.os}}" | bash
+
+      - name: Test executable [mac]
+        if: runner.os == 'macOS'
+        shell: bash
+        run: |
+          brew install coreutils
+          echo "Checking dependencies"
+          # test build starts up - should see the output of qt_debug_plugins. the command will kill itself in 10s if everything works. something went wrong if time taken for this command is less than 10s.
+          # then zip everything up and delete the original non-zipped file.
+          echo "Starting GUI..."
+          start=$(date +%s)
+          echo "gtimeout 10 ${{ steps.build-exe.outputs.out-filepath }}/Contents/MacOS/${{ steps.build-exe.outputs.out-filename }}" | bash || true
+          if (($(date +%s) - $start < 10)); then
+            echo "::error::Process terminated early! Potential errors in build."
+            exit 1
+          fi
+          echo "\n\nStarting CLI..."
+          echo "gtimeout 10 ${{ steps.build-exe.outputs.out-filepath }}/Contents/MacOS/${{ steps.build-exe.outputs.out-filename }} --user-interface=cli" | bash || true
+
+      - name: Test executable [Windows]
+        if: runner.os == 'Windows'
         shell: bash
-        run: ${{matrix.CMD_BUILD}}
+        run: |
+          echo "Checking dependencies"
+          # test build starts up - should see the output of qt_debug_plugins. the command will kill itself in 10s if everything works. something went wrong if time taken for this command is not 10s.
+          echo "Starting GUI..."
+          start=$(date +%s)
+          echo "timeout 10 ${{ steps.build-exe.outputs.out-filepath }}" | bash || true
+          if (($(date +%s) - $start < 10)); then
+            echo "::error::Process terminated early! Potential errors in build."
+            exit 1
+          fi
+          echo "\n\nStarting CLI..."
+          echo "timeout 10 ${{ steps.build-exe.outputs.out-filepath }} --user-interface=cli" | bash || true
+
+      - name: Test executable [Linux]
+        id: set-path
+        if: runner.os == 'Linux'
+        shell: bash
+        run: |
+          echo "path=${{ steps.build-exe.outputs.out-filename }}" >> "$GITHUB_OUTPUT"
+          echo "Checking dependencies"
+          # test build starts up - should see the output of qt_debug_plugins. the command will kill itself in 10s if everything works. something went wrong if time taken for this command is not 10s.
+          echo "Starting GUI..."
+          start=$(date +%s)
+          echo "timeout 10 ${{ steps.build-exe.outputs.out-filepath }}" | bash || true
+          if (($(date +%s) - $start < 10)); then
+            echo "::error::Process terminated early! Potential errors in build."
+            exit 1
+          fi
+          echo "\n\nStarting CLI..."
+          echo "timeout 10 ${{ steps.build-exe.outputs.out-filepath }} --user-interface=cli" | bash || true
 
       - name: Upload executable
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
+        with:
+          name: ${{ steps.build-exe.outputs.out-filename }}
+          path: build/*/exe
+          retention-days: 1
+
+  deploy:
+    name: Create release
+    continue-on-error: true
+    needs: build
+    runs-on: "ubuntu-latest"
+    permissions:
+      contents: write
+    env:
+      QT_DEBUG_PLUGINS: 1
+      QT_QPA_PLATFORM: offscreen
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Download executable
+        uses: actions/download-artifact@v8
+        with:
+          path: build/
+          pattern: 'TiLiA-v*'
+          merge-multiple: true
+
+      - name: Test Linux still works in a clean environment
+        continue-on-error: true
+        id: test-linux
+        run: |
+          if [ -e build/ubuntu/exe/${{ needs.build.outputs.linux-build }} ];
+            then
+              chmod ugo+x build/ubuntu/exe/${{ needs.build.outputs.linux-build }}
+              echo "Starting GUI..."
+              start=$(date +%s)
+              echo "timeout 10 build/ubuntu/exe/${{ needs.build.outputs.linux-build }}" | bash || true
+              if (($(date +%s) - $start < 10));
+                then
+                  echo "Linux started in a clean environment!";
+              else
+                echo "Linux didn't work... Check libraries with previous step?";
+              fi;
+              echo "Starting CLI..."
+              echo "timeout 10 build/ubuntu/exe/${{ needs.build.outputs.linux-build }} --user-interface=cli" | bash || true
+          else
+            echo "file not found!";
+          fi
+          ls build -ltraR |egrep -v '\.$|\.\.|\.:|\.\/|total|^d' | sed '/^$/d' || true
+
+      - name: Upload
+        uses: "softprops/action-gh-release@v2"
         with:
-          name: ${{env.OUT_FILE_NAME}}
-          path: dist/${{env.OUT_FILE_NAME}}
+          tag_name: ${{github.ref_name}}
+          make_latest: ${{github.event_name == 'push'}}
+          generate_release_notes: true
+          files: |
+            build/*/exe/TiLiA-v*

.github/workflows/run-tests.yml

@@ -24,8 +24,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        # TODO: test for 3.13
-        python-version: ['3.10', '3.11', '3.12']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
         os: [macos-latest, ubuntu-latest, windows-latest]
         include:
         - os: ubuntu-latest
@@ -34,27 +33,31 @@ jobs:
           path: ~/Library/Caches/pip
         - os: windows-latest
           path: ~\AppData\Local\pip\Cache
+        exclude:
+          - os: windows-latest
+            python-version: '3.13' # no pyside support
     timeout-minutes: 30
     env:
-      DISPLAY: ":99.0"
-      QT_SELECT: "qt6"
+      QT_QPA_PLATFORM: offscreen
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v6
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
 
-    - name: Setup xvfb (Linux)
+    - name: Setup additional Linux dependencies
       if: runner.os == 'Linux'
       run: |
-        sudo apt-get update
-        sudo apt-get install -y xvfb libxkbcommon-x11-0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-xinerama0 libxcb-xinput0 libxcb-xfixes0 libxcb-shape0 libglib2.0-0 libgl1-mesa-dev libpulse-dev
-        sudo apt-get install '^libxcb.*-dev' libx11-xcb-dev libglu1-mesa-dev libxrender-dev libxi-dev libxkbcommon-dev libxkbcommon-x11-dev
-        sudo /usr/bin/Xvfb $DISPLAY -screen 0 1280x1024x24 &
+        chmod +x ./scripts/linux-setup.sh
+        ./scripts/linux-setup.sh
 
-    - uses: actions/cache@v4
+    - name: Install timeout
+      if: runner.os == 'macOS'
+      run: brew install coreutils
+
+    - uses: actions/cache@v5
       with:
         path: ${{ matrix.path }}
         key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
@@ -64,15 +67,15 @@ jobs:
     - name: Install Python dependencies
       run: |
         python -m pip install --upgrade pip wheel
-        pip install -e .[testing,ci-tests]
+        pip install -e . --group testing --group ci-tests
 
     - name: List installed packages
       run: |
         pip freeze
 
-    - name: Lint with flake8
+    - name: Lint with ruff
       run: |
-        flake8
+        ruff check
       continue-on-error: true
 
     - name: Test with pytest
@@ -82,3 +85,12 @@ jobs:
     - name: Generate Coverage Report
       run: |
           coverage report -m
+
+    - name: Check Program
+      shell: bash
+      run: |
+        export QT_DEBUG_PLUGINS=1
+        echo "Starting GUI..."
+        timeout 10 tilia || true
+        echo "Starting CLI..."
+        timeout 10 tilia -i=cli || true

.gitignore

@@ -6,9 +6,7 @@
 /.pytest_cache/
 /build/
 /dist/
-/tilia/installers/win/tilia*
 /tilia.egg-info/
 /venv/
 __pycache__/
-pytest.ini
 tilia/dev/

.pre-commit-config.yaml

@@ -1,20 +1,21 @@
 repos:
--   repo: https://github.com/psf/black
+  - repo: https://github.com/psf/black
     rev: 22.12.0
     hooks:
-    - id: black
+      - id: black
 
--   repo: https://github.com/pre-commit/pre-commit-hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: check-added-large-files
-        args: ['--maxkb=1000']
+        args: ["--maxkb=1000"]
       - id: debug-statements
       - id: check-yaml
 
--   repo: https://github.com/pycqa/flake8
-    rev: 7.1.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.0
     hooks:
-    -   id: flake8
+      - id: ruff-check
+        args: [ --fix ]

.tilia.env

@@ -0,0 +1,3 @@
+LOG_REQUESTS = 1
+EXCLUDE_FROM_LOG = TIMELINE_VIEW_LEFT_BUTTON_DRAG;PLAYER_CURRENT_TIME_CHANGED;APP_STATE_RECORD
+ENVIRONMENT='dev'

CONTRIBUTING.md

@@ -28,4 +28,11 @@ If you find a bug, [check](https://github.com/TimeLineAnnotator/desktop/issues)
 # Suggesting features or enhancements
 We are very much looking for ideas of new features for TiLiA. If you would like to suggest one, [check](https://github.com/TimeLineAnnotator/desktop/issues) to see if your feature has already been requested. If not, [open a new one](https://github.com/TimeLineAnnotator/desktop/issues/new) detailing your suggestion.
 
-You need Python 3.11 to build and test TiLiA. You will also need to have ffmpeg installed to use the export and convert audio features.
+You need Python >=3.10 to build and test TiLiA. You will also need to have ffmpeg installed to use the export and convert audio features.
+
+# Developing for TiLiA
+For a better development experience, we recommend the installation of a few more packages:
+```
+pip install --group dev --group testing
+pre-commit install
+```