pull

.github/workflows/deploy-docs.yml

@@ -13,8 +13,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
         with:
-          python-version: 3.x
-      - run: pip install mkdocs mkdocs-material
-      - run: mkdocs gh-deploy --force
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Install docs dependencies
+        run: uv sync --locked --extra docs
+
+      - name: Deploy
+        run: uv run mkdocs gh-deploy --force

.github/workflows/python-ci.yml

@@ -1,26 +1,58 @@
 name: Python CI
 
 on:
+  push:
+    branches: [main]
+  pull_request:
   workflow_dispatch:
 
 jobs:
-  build:
+  lint:
+    name: Lint & format
     runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Install dev dependencies
+        run: uv sync --locked --extra dev
+
+      - name: ruff check
+        run: uv run ruff check .
+
+      - name: ruff format (check)
+        run: uv run ruff format --check .
+
+      - name: ty check (experimental)
+        run: uv run ty check .
+        continue-on-error: true  # ty is still in early release
 
+  test:
+    name: Tests
+    runs-on: ubuntu-latest
     steps:
-    - name: Check out the repository
-      uses: actions/checkout@v3
-
-    - name: Set up Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: "3.11"
-
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        python -m pip install -r requirements.txt
-
-    - name: Run syntax check
-      run: |
-        python -m py_compile app.py
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Install dependencies
+        run: uv sync --locked
+
+      - name: Syntax check
+        run: uv run python -m py_compile app.py
+
+      - name: Run tests
+        run: uv run python -m unittest discover -s tests

.gitignore

@@ -6,10 +6,19 @@
 build/
 dist/
 
-# Python virtual environments
-venv/
+# Python virtual environment (project standard)
 .venv/
 
+# Frontend dependencies and build artifacts
+frontend/node_modules/
+frontend/.next/
+frontend/out/
+
+# Tauri/Rust build artifacts
+frontend/src-tauri/target/
+frontend/src-tauri/gen/
+frontend/src-tauri/binaries/
+
 # Local environment secrets
 .env
 .env.local
@@ -28,6 +37,4 @@ document.html
 LICENCE.pdf
 .gitignore
 
-scripts
-
 site/

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.5
+    hooks:
+      # Fix lint issues (including import sorting I001)
+      - id: ruff
+        args: [--fix]
+      # Auto-format code
+      - id: ruff-format

.python-version

@@ -0,0 +1 @@
+3.14

CONTRIBUTORS.md

@@ -26,6 +26,9 @@ Thank you to all the contributors who have helped make Markdown Reader better!
 - [@raza-khan0108](https://github.com/raza-khan0108) - Code contributions
 - [@O-sama12](https://github.com/O-sama12) - QA and testing
 
+- [@korbonits](https://github.com/korbonits) - chore: migrate to uv, ruff, and ty (#158)
+- [@Yolsh](https://github.com/Yolsh) - moved the installation instructions round so that it made more sense … (#164)
+- [@dhuhaaf](https://github.com/dhuhaaf) - new features: add word count status bar and recent files menu (#165)
 ## How to Contribute
 
 We welcome contributions! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) guide for details on how to: