Switch development dependencies to using uv instead of pip-tools (#48)

Author: andrewtavis

.github/workflows/pr_ci_i18n.yaml

@@ -10,11 +10,15 @@ on:
       - synchronize
     paths:
       - "frontend/**"
+      - "pyproject.toml"
+      - "uv.lock"
   push:
     branches:
       - main
     paths:
       - "frontend/**"
+      - "pyproject.toml"
+      - "uv.lock"
 
 jobs:
   i18n_check:
@@ -28,16 +32,14 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.11"
+          python-version: "3.12"
 
-      - name: Create Environment and Install Dependencies
-        run: |
-          python -m pip install --upgrade uv
-          uv venv
-          . .venv/bin/activate
-          uv pip install -r requirements-dev.txt
-          echo "$PWD/.venv/bin" >> $GITHUB_PATH
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Install Dependencies
+        run: uv sync --frozen --all-extras
 
       - name: Execute All i18n-check Key-Value Checks
         run: |
-          i18n-check -a
+          uv run i18n-check -a

CONTRIBUTING.md

@@ -177,21 +177,27 @@ git remote add upstream https://github.com/scribe-org/scri.be.git
   - `origin` (forked repository)
   - `upstream` (scri.be repository)
 
-4. Create a virtual environment for the developer tools, activate it and install dependencies:
+4. Create a virtual environment for i18n-check (Python `>=3.12`), activate it and install dependencies:
 
-    ```bash
-    # Unix or MacOS:
-    python3 -m venv venv
-    source venv/bin/activate
+   > [!NOTE]
+   > First, install `uv` if you don't already have it by following the [official installation guide](https://docs.astral.sh/uv/getting-started/installation/).
 
-    # Windows:
-    python -m venv venv
-    venv\Scripts\activate.bat
+   ```bash
+   uv sync --all-extras  # create .venv and install all dependencies from uv.lock
+
+   # Unix or macOS:
+   source .venv/bin/activate
+
+   # Windows:
+   .venv\Scripts\activate.bat  # .venv\Scripts\activate.ps1 (PowerShell)
+   ```
 
-    # After activating venv:
-    pip install --upgrade pip
-    pip install -r requirements-dev.txt
-    ```
+> [!NOTE]
+> If you change dependencies in `pyproject.toml`, regenerate the lock file with the following command:
+>
+> ```bash
+> uv lock  # refresh uv.lock for reproducible installs
+> ```
 
 5. Start your docker images with the following:
 
@@ -213,6 +219,7 @@ git remote add upstream https://github.com/scribe-org/scri.be.git
    ```bash
    # In the project root:
    pre-commit install
+   # uv run pre-commit run --all-files  # lint and fix common problems in the codebase
    ```
 
 > [!NOTE]
@@ -222,6 +229,11 @@ git remote add upstream https://github.com/scribe-org/scri.be.git
 > pip install pre-commit
 > ```
 
+You're now ready to work on `scri.be`!
+
+> [!NOTE]
+> Feel free to contact the team in the [Web room on Matrix](https://matrix.to/#/#scri.be:matrix.org) if you're having problems getting your environment setup!
+
 <a id="style-guide-"></a>
 
 ## Style guide [`⇧`](#contents)

README.md

@@ -148,21 +148,27 @@ git remote add upstream https://github.com/scribe-org/scri.be.git
   - `origin` (forked repository)
   - `upstream` (scri.be repository)
 
-4. Create a virtual environment for the developer tools, activate it and install dependencies:
+4. Create a virtual environment for i18n-check (Python `>=3.12`), activate it and install dependencies:
 
-    ```bash
-    # Unix or MacOS:
-    python3 -m venv venv
-    source venv/bin/activate
+   > [!NOTE]
+   > First, install `uv` if you don't already have it by following the [official installation guide](https://docs.astral.sh/uv/getting-started/installation/).
 
-    # Windows:
-    python -m venv venv
-    venv\Scripts\activate.bat
+   ```bash
+   uv sync --all-extras  # create .venv and install all dependencies from uv.lock
+
+   # Unix or macOS:
+   source .venv/bin/activate
 
-    # After activating venv:
-    pip install --upgrade pip
-    pip install -r requirements-dev.txt
-    ```
+   # Windows:
+   .venv\Scripts\activate.bat  # .venv\Scripts\activate.ps1 (PowerShell)
+   ```
+
+> [!NOTE]
+> If you change dependencies in `pyproject.toml`, regenerate the lock file with the following command:
+>
+> ```bash
+> uv lock  # refresh uv.lock for reproducible installs
+> ```
 
 5. Start your docker images with the following:
 
@@ -184,6 +190,7 @@ git remote add upstream https://github.com/scribe-org/scri.be.git
    ```bash
    # In the project root:
    pre-commit install
+   # uv run pre-commit run --all-files  # lint and fix common problems in the codebase
    ```
 
 > [!NOTE]
@@ -193,6 +200,11 @@ git remote add upstream https://github.com/scribe-org/scri.be.git
 > pip install pre-commit
 > ```
 
+You're now ready to work on `scri.be`!
+
+> [!NOTE]
+> Feel free to contact the team in the [Web room on Matrix](https://matrix.to/#/#scri.be:matrix.org) if you're having problems getting your environment setup!
+
 <a id="tech-stack"></a>
 
 ## Tech Stack [`⇧`](#contents)

pyproject.toml

@@ -0,0 +1,18 @@
+[project]
+name = "scri.be"
+version = "1.0.0"
+description = "Scribe's community portal scri.be"
+readme = "README.md"
+requires-python = ">=3.12"
+
+dependencies = []
+
+[project.optional-dependencies]
+dev = [
+    # Keep docs dependencies formatted in this way with ruff to allow for upgrades via VS Code extension.
+    "i18n-check>=1.18.0",
+    "pre-commit>=4.5.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/scribe-org/scri.be"