Moderize and restructure codebase (#582)

Author: No767

.config.dist.yml

@@ -0,0 +1,10 @@
+# Kumiko's main configuration
+token: ""
+dev_mode: False
+
+prometheus:
+  enabled: True
+  host: localhost
+  port: 8770
+
+postgres_uri: ""

docker/example.env renamed to .env.dist

@@ -1,12 +1,12 @@
-# The location of where Kumiko's configuration is stored.
-# The configuration can be found under the config-example.yml
-# MUST be absolute path
-CONFIG_LOCATION=./config.yml
-
-# Connection secret for the postgres user. You should change it to a random password
-DB_PASSWORD=password
-
-# The values below this line do not need to be changed
-###################################################################################
-DB_USERNAME=postgres
-DB_DATABASE_NAME=kumiko
+# The location of where Kumiko's configuration is stored.
+# The configuration can be found under the config-example.yml
+# MUST be absolute path
+CONFIG_LOCATION=./config.yml
+
+# Connection secret for the postgres user. You should change it to a random password
+DB_PASSWORD=password
+
+# The values below this line do not need to be changed
+###################################################################################
+DB_USERNAME=postgres
+DB_DATABASE=kumiko

.github/CONTRIBUTING.md

@@ -9,7 +9,7 @@ The following is a set of guidelines for contributing to the repository. These a
 
 Generally, there are much better resources that are available. These include:
 
-- The official support server: [https://discord.gg/ns3e74frqn]
+- The official support server: <https://discord.gg/ns3e74frqn>
 - FAQ in the documentation
 
 Make sure to not ask questions in the issue tracker.

.github/dependabot.yml

@@ -1,15 +1,14 @@
 version: 2
 updates:
-  - package-ecosystem: "pip"
-    directory: "/"
+  - package-ecosystem: uv
+    directory: /backend
     schedule:
-      interval: "weekly"
+      interval: weekly
     commit-message:
-      prefix: "[pip]"
+      prefix: "[uv]"
       include: "scope"
-    target-branch: "main"
     groups:
-      dev-deps:
-        dependency-type: "development"
-      prod-deps:
-        dependency-type: "production"
+      dependencies:
+        applies-to: version-updates
+        patterns:
+          - "*"

.github/workflows/auto-approve.yml

@@ -4,6 +4,7 @@ on: pull_request_target
 
 jobs:
   auto-approve:
+    name: auto-approve
     runs-on: ubuntu-24.04
 
     permissions:
@@ -12,4 +13,5 @@ jobs:
     if: github.actor == 'dependabot[bot]'
 
     steps:
-      - uses: hmarr/auto-approve-action@v4
+      - name: Auto Approve
+        uses: hmarr/auto-approve-action@8f929096a962e83ccdfa8afcf855f39f12d4dac7 # 4.0.0

.github/workflows/codeql.yml

@@ -3,19 +3,23 @@ name: "CodeQL"
 on:
   push:
     branches: [main]
-    
+
   pull_request:
     branches: [main]
 
 jobs:
   Analyze:
     name: Analyze
     runs-on: ubuntu-24.04
+
     permissions:
       actions: read
       contents: read
       security-events: write
 
+    env:
+      UV_CACHE_DIR: /tmp/.uv-cache
+
     steps:
     - name: Checkout Repository
       uses: actions/checkout@v4
@@ -25,21 +29,28 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: '3.x'
-        
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e # 6.8.0
+      with:
+        version: "latest"
+        enable-cache: true
+
     - name: Cache Dependencies
-      id: cache-pip
+      id: cache-uv
       uses: actions/cache@v4
       with:
-        path: ~/.cache/pip
-        key: ${{ runner.os }}-codeql-pip-${{ hashFiles('**/requirements.txt') }}
+        path: /tmp/.uv-cache
+        key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
         restore-keys: |
-          ${{ runner.os }}-codeql-pip-
-    
+          uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+          uv-${{ runner.os }}
+  
     - name: Install Dependencies
-      if: steps.cache-pip.outputs.cache-hit != 'true'
+      if: steps.cache-uv.outputs.cache-hit != 'true'
       run: |
-        pip install -r requirements.txt
-
+        uv sync --frozen --no-default-groups
+    
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v3
       with:
@@ -48,4 +59,8 @@ jobs:
     - name: Perform CodeQL Analysis
       uses: github/codeql-action/analyze@v3
       with:
-        upload: true
+        upload: true
+
+    - name: Minimize uv cache
+      run: |
+        uv cache prune --ci

.github/workflows/dependabot-auto-merge.yml

@@ -4,7 +4,7 @@ on:
     types: [opened]
 
   workflow_run:
-    workflows: ["Lint"]
+    workflows: ["Lint", "CodeQL"]
     branches: [main]
     types: [completed]
 
@@ -15,16 +15,18 @@ permissions:
 jobs:
   dependabot:
     runs-on: ubuntu-24.04
+    
     if: ${{ github.actor == 'dependabot[bot]'}}
     steps:
+    
       - name: Dependabot metadata
         id: metadata
         uses: dependabot/fetch-metadata@v2
         with:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
-
+          
       - name: Enable auto-merge for Dependabot PRs
-        if: ${{steps.metadata.outputs.update-type != 'version-update:semver-major'}}
+        if: ${{ steps.metadata.outputs.update-type != 'version-update:semver-major' }}
         run: gh pr merge --auto --squash "$PR_URL"
         env:
           PR_URL: ${{ github.event.pull_request.html_url }}

.github/workflows/docker.yml

@@ -37,7 +37,7 @@ jobs:
         uses: docker/login-action@v3
         with:
           registry: ghcr.io
-          username: no767
+          username: ${{ github.repository_owner }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Build and push image

.github/workflows/lint.yml

@@ -8,29 +8,60 @@ on:
 
 jobs:
   Check:
+    name: Check (${{ matrix.version }})
     runs-on: ubuntu-24.04
 
     strategy:
       fail-fast: false
       matrix:
         version: ['3.10', '3.11', '3.12', '3.13']
 
+    env:
+      # Configure a constant location for the uv cache
+      UV_CACHE_DIR: /tmp/.uv-cache
+
     steps:
       - name: Checkout Repository  
         uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.version }}
-        id: setup-python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.version }}
 
-      - name: Install Tox
+      - name: Install uv
+        uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e # 6.8.0
+        with:
+          version: "latest"
+          enable-cache: true
+
+      - name: Cache Dependencies
+        id: cache-uv
+        uses: actions/cache@v4
+        with:
+          path: /tmp/.uv-cache
+          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+          restore-keys: |
+            uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+            uv-${{ runner.os }}
+
+      - name: Install Dependencies
+        if: steps.cache-uv.outputs.cache-hit != 'true'
+        run: |
+          uv sync --frozen
+
+      - name: Check typing
+        run: |
+          uv run pyright src
+
+      - name: Check codebase
+        run: |
+          uv run ruff check src --exit-non-zero-on-fix
+
+      - name: Check for formatting
         run: |
-          pip install "tox>=4.23.2,<5"
+          uv run ruff format src --check
 
-      - name: Lint Codebase
+      - name: Minimize uv cache
         run: |
-          RAW_PYTHON_VERSION=${{ matrix.version }}
-          PYTHON_VERSION=$(echo $RAW_PYTHON_VERSION | sed 's/\.//')
-          tox -e $PYTHON_VERSION
+          uv cache prune --ci

.github/workflows/release.yml

@@ -67,4 +67,4 @@ jobs:
         token: ${{ secrets.PAT_TOKEN }}
         tag: ${{ steps.tag_version.outputs.new_tag }}
         name: ${{ steps.tag_version.outputs.new_tag }}
-        artifacts: "releases/kumiko-docker.zip,releases/kumiko-docker.tar.gz"
+        artifacts: "releases/kumiko-docker.zip,releases/kumiko-docker.tar.gz"