Merge pull request #844 from TagStudioDev/layout-refactor-1

refactor!: restructure project to use proper src-layout

Author: xarvex

.envrc.recommended

@@ -1,16 +1,18 @@
-# vi: ft=bash
-#
 # If you wish to use this file, copy or symlink it to `.envrc` for direnv to read it.
 # This will use the flake development shell.
 
-if ! has nix_direnv_version || ! nix_direnv_version 3.0.5; then
-    source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/3.0.5/direnvrc" "sha256-RuwIS+QKFj/T9M2TFXScjBsLR6V3A17YVoEW/Q6AZ1w="
+if ! has nix_direnv_version || ! nix_direnv_version 3.0.6; then
+    source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/3.0.6/direnvrc" "sha256-RYcUJaRMf8oF5LznDrlCXbkOQrywm0HDv1VjYGaJGdM="
 fi
 
-devenv_root_file="$(mktemp -t devenv-root-XXXXXXXX)"
-printf %s "${PWD}" >"${devenv_root_file}"
-if ! use flake . --override-input devenv-root "file+file://${devenv_root_file}"; then
-    printf '%s\n' "devenv could not be built. The devenv environment was not loaded. Make the necessary changes to devenv.nix and hit enter to try again." >&2
+if [ -f .venv/bin/activate ]; then
+    # If the file is watched when it does not exist,
+    # direnv will execute again when it gets created.
+    watch_file .venv/bin/activate
 fi
-rm "${devenv_root_file}"
-unset devenv_root_file
+watch_file nix/shell.nix
+watch_file pyproject.toml
+
+use flake
+
+# vi: ft=bash

.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,38 +1,49 @@
-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
 
 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
-
-      - 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
+            libxkbcommon-x11-0 \
+            libyaml-dev \
+            x11-utils
 
-      - 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