refactor!: change layout; import and build change

Fixes: #200
Fixes: #365
Fixes: #512
Fixes: #800

fix(pyproject): resolve mix-up of mypy and pytest

chore(ci): remove legacy scripts

chore: format with new mypy rules; fix translation test

wip(ci/mypy): remove config flag

fix(pyinstaller): use correct dict access

fix(resources): usage in ts_qt.py

feat(nix/package): validate tests with pytest hook

fix(nix/package): remove old dependency patch

feat(nix): support Darwin

fix(nix/package): move check deps to checkInputs

fix(nix/shell): typo

fix(nix/shell): correctly wrap Python with Qt args

fix(pyproject): specify mypy-extensions

feat(nix/package): provide pillow-jxl-plugin

nix(nix/package): split into multiple files, allow overriding of JXL and vtf2img

fix(nix/shell): provide FFmpeg on runtime

feat(flake): output pillow-jxl-plugin and vtf2img

fix(nix/package): load pipewire

feat(nix/package): run tests on pillow-jxl-plugin

fix: remove extra noqa comment

docs: update installation docs

docs: shrink table size on docs site

nit(nix/package): pipewire not needed in buildInputs

docs: update commands, environment, setup

fix: use consistent possessives

chore: format with prettier, add ignore flags

fix(pyinstaller): consume from pyproject

Revert "fix(pyinstaller): consume from pyproject"

This reverts commit 398cd4e5630a3e83d22d15286d7ac59b4c07c5d6.

refactor: use icon from resource manager

Also fixes incorrect path currently used in ts_qt.py.

nix(pyinstaller): replace use of sys.platform with platform.system

docs: add build section

Co-authored-by: Travis Abendshien <46939827+CyanVoxel@users.noreply.github.com>

.github/FUNDING.yml

@@ -1 +1,2 @@
+---
 patreon: cyanvoxel

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,3 +1,4 @@
+---
 name: Bug Report
 description: File a bug or issue report.
 title: '[Bug]: '
@@ -51,7 +52,7 @@ body:
   - type: textarea
     attributes:
       label: Steps to Reproduce
-      description: Minimal steps neded for the problem to occur.
+      description: Minimal steps needed for the problem to occur.
       placeholder: |
         1.
         2.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,3 +1,4 @@
+---
 name: Feature Request
 description: Suggest a new feature.
 title: '[Feature Request]: '

.github/workflows/mypy.yaml

@@ -1,38 +1,34 @@
+---
 name: MyPy
 
-on: [ push, pull_request ]
-
+on: [push, pull_request]
 
 jobs:
   mypy:
     name: Run MyPy
     runs-on: ubuntu-latest
-
     steps:
-      - name: Checkout code
+      - name: Checkout repo
         uses: actions/checkout@v4
 
-      - uses: reviewdog/action-setup@v1
+      - name: Setup reviewdog
+        uses: reviewdog/action-setup@v1
         with:
           reviewdog_version: latest
 
-      - uses: actions/setup-python@v5
+      - name: Setup Python
+        uses: actions/setup-python@v5
         with:
           python-version: '3.12'
-          cache: 'pip'
+          cache: pip
 
-      - name: Install dependencies
+      - name: Install Python dependencies
         run: |
           python -m pip install --upgrade uv
-          uv pip install --system -r requirements.txt
-          uv pip install --system mypy==1.11.2
-          mkdir tagstudio/.mypy_cache
+          uv pip install --system .[mypy]
 
-      - uses: tsuyoshicho/action-mypy@v4
+      - name: Execute MyPy
+        uses: tsuyoshicho/action-mypy@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          reporter: github-check
           fail_on_error: true
-          workdir: tagstudio
-          level: error
-          mypy_flags: --config-file ../pyproject.toml

.github/workflows/publish_docs.yaml

@@ -1,19 +1,20 @@
-name: Publish Docs 
+---
+name: Publish Docs
 
 on:
   push:
     branches:
       - main
     paths:
-      - 'docs/**'
-      - 'mkdocs.yml'
-      - 'CHANGELOG.md'
-      - '.github/workflows/publish_docs.yaml'
+      - .github/workflows/publish_docs.yaml
+      - docs/**
+      - mkdocs.yml
+      - CHANGELOG.md
 
 permissions:
   contents: write
 
-concurrency: 
+concurrency:
   group: publish-docs
   cancel-in-progress: true
 
@@ -21,18 +22,28 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.x
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+          python-version: '3.12'
+          cache: pip
+
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade uv
+          uv pip install --system .[mkdocs]
+
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+
       - uses: actions/cache@v4
         with:
           key: mkdocs-material-${{ env.cache_id }}
           path: .cache
           restore-keys: |
                   mkdocs-material-
-      - run: pip install mkdocs-material mkdocs-material[imaging]
-      - run: mkdocs gh-deploy --force
-
 
+      - name: Execute mkdocs
+        run: mkdocs gh-deploy --force

.github/workflows/pytest.yaml

@@ -1,10 +1,11 @@
+---
 name: pytest
 
-on: [ push, pull_request ]
+on: [push, pull_request]
 
 jobs:
   pytest:
-    name: Run tests
+    name: Run pytest
     runs-on: ubuntu-24.04
 
     steps:
@@ -15,56 +16,54 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.12'
-          cache: 'pip'
+          cache: pip
+
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade uv
+          uv pip install --system .[pytest]
 
       - name: Install system dependencies
         run: |
-          # dont run update, it is slow
           sudo apt-get update
           sudo apt-get install -y --no-install-recommends \
-            libxkbcommon-x11-0 \
-            x11-utils \
-            libyaml-dev \
-            libgl1 \
             libegl1 \
+            libgl1 \
+            libopengl0 \
+            libpulse0 \
+            libxcb-cursor0 \
             libxcb-icccm4 \
             libxcb-image0 \
             libxcb-keysyms1 \
             libxcb-randr0 \
             libxcb-render-util0 \
             libxcb-xinerama0 \
-            libopengl0 \
-            libxcb-cursor0 \
-            libpulse0
+            libxkbcommon-x11-0 \
+            libyaml-dev \
+            x11-utils
 
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade uv
-          uv pip install --system -r requirements.txt
-          uv pip install --system -r requirements-dev.txt
-
-      - name: Run pytest
+      - name: Execute pytest
         run: |
           xvfb-run pytest --cov-report xml --cov=tagstudio
 
-      - name: Store coverage
+      - name: Upload coverage
         uses: actions/upload-artifact@v4
         with:
-          name: 'coverage'
-          path: 'coverage.xml'
+          name: coverage
+          path: coverage.xml
 
   coverage:
-    name: Check Code Coverage
+    name: Check coverage
     runs-on: ubuntu-latest
     needs: pytest
 
     steps:
-      - name: Load coverage
+      - name: Fetch coverage
         uses: actions/download-artifact@v4
         with:
-          name: 'coverage'
+          name: coverage
 
-      - name: Check Code Coverage
+      - name: Check coverage
         uses: yedpodtrzitko/coverage@main
         with:
           thresholdAll: 0.4

.github/workflows/release.yml

@@ -1,3 +1,4 @@
+---
 name: Release
 
 on:
@@ -19,15 +20,27 @@ jobs:
             suffix: _portable
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
         with:
           python-version: '3.12'
-          cache: 'pip'
-      - run: pip install -Ur requirements.txt pyinstaller
-      - run: pyinstaller tagstudio.spec -- ${{ matrix.build-flag }}
-      - run: tar czfC dist/tagstudio_linux_x86_64${{ matrix.suffix }}.tar.gz dist tagstudio
-      - uses: actions/upload-artifact@v4
+          cache: pip
+
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade uv
+          uv pip install --system .[pyinstaller]
+
+      - name: Execute PyInstaller
+        run: |
+          pyinstaller tagstudio.spec -- ${{ matrix.build-flag }}
+          tar czfC dist/tagstudio_linux_x86_64${{ matrix.suffix }}.tar.gz dist tagstudio
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
         with:
           name: tagstudio_linux_x86_64${{ matrix.suffix }}
           path: dist/tagstudio_linux_x86_64${{ matrix.suffix }}.tar.gz
@@ -41,20 +54,35 @@ jobs:
             arch: x86_64
           - os-version: '14'
             arch: aarch64
+
     runs-on: macos-${{ matrix.os-version }}
+
     env:
-      # even though we run on 12, target towards compatibility
+      # INFO: Even though we run on 13, target towards compatibility
       MACOSX_DEPLOYMENT_TARGET: '11.0'
+
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
         with:
           python-version: '3.12'
-          cache: 'pip'
-      - run: pip install -Ur requirements.txt pyinstaller
-      - run: pyinstaller tagstudio.spec
-      - run: tar czfC dist/tagstudio_macos_${{ matrix.arch }}.tar.gz dist TagStudio.app
-      - uses: actions/upload-artifact@v4
+          cache: pip
+
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade uv
+          uv pip install --system .[pyinstaller]
+
+
+      - name: Execute PyInstaller
+        run: |
+          pyinstaller tagstudio.spec
+          tar czfC dist/tagstudio_macos_${{ matrix.arch }}.tar.gz dist TagStudio.app
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
         with:
           name: tagstudio_macos_${{ matrix.arch }}
           path: dist/tagstudio_macos_${{ matrix.arch }}.tar.gz
@@ -72,30 +100,51 @@ jobs:
             build-flag: --portable
             suffix: _portable
             file-end: .exe
+
     runs-on: windows-2019
+
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
         with:
           python-version: '3.12'
-          cache: 'pip'
-      - run: pip install -Ur requirements.txt pyinstaller
-      - run: PyInstaller tagstudio.spec -- ${{ matrix.build-flag }}
-      - run: Compress-Archive -Path dist/TagStudio${{ matrix.file-end }} -DestinationPath dist/tagstudio_windows_x86_64${{ matrix.suffix }}.zip
-      - uses: actions/upload-artifact@v4
+          cache: pip
+
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade uv
+          uv pip install --system .[pyinstaller]
+
+      - name: Execute PyInstaller
+        run: |
+          PyInstaller tagstudio.spec -- ${{ matrix.build-flag }}
+          Compress-Archive -Path dist/TagStudio${{ matrix.file-end }} -DestinationPath dist/tagstudio_windows_x86_64${{ matrix.suffix }}.zip
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
         with:
           name: tagstudio_windows_x86_64${{ matrix.suffix }}
           path: dist/tagstudio_windows_x86_64${{ matrix.suffix }}.zip
 
   publish:
     needs: [linux, macos, windows]
+
     runs-on: ubuntu-latest
+
     permissions:
       contents: write
+
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/download-artifact@v4
-      - uses: softprops/action-gh-release@v2
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Fetch artifacts
+        uses: actions/download-artifact@v4
+
+      - name: Publish release
+        uses: softprops/action-gh-release@v2
         with:
           files: |
             tagstudio_linux_x86_64/*

.github/workflows/ruff.yaml

@@ -1,20 +1,31 @@
+---
 name: Ruff
-on: [ push, pull_request ]
+
+on: [push, pull_request]
+
 jobs:
   ruff-format:
+    name: Run Ruff format
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: chartboost/ruff-action@v1
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Execute Ruff format
+        uses: chartboost/ruff-action@v1
         with:
-          version: 0.6.4
-          args: 'format --check'
+          version: 0.8.1
+          args: format --check
 
   ruff-check:
+    name: Run Ruff check
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: chartboost/ruff-action@v1
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Execute Ruff check
+        uses: chartboost/ruff-action@v1
         with:
-          version: 0.6.4
-          args: 'check'
+          version: 0.8.1
+          args: check