Merge pull request #97 from GeriLife/migrate-to-uv

Migrate to UV package manager for dependency management

Author: brylie

.github/workflows/django.yml renamed to .github/workflows/ci.yml

@@ -20,18 +20,34 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-          cache: "pip"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Cache UV dependencies
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cache/uv
+          key: ${{ runner.os }}-uv-python-${{ matrix.python-version }}-${{ hashFiles('pyproject.toml', 'uv.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-uv-python-${{ matrix.python-version }}-
+            ${{ runner.os }}-uv-
+
       - name: Install Dependencies
-        run: pip install -r requirements.dev.txt
+        run: uv sync --dev
+
       - name: Run Tests
-        run: coverage run --source='.' manage.py test
+        run: uv run coverage run --source='.' manage.py test
+
       - name: Upload Coverage
         uses: paambaati/[email protected]
         env:
           CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
         with:
-          coverageCommand: coverage xml
+          coverageCommand: uv run coverage xml

CONTRIBUTING.md

@@ -10,12 +10,18 @@ such as bug reports, ideas, design, testing, and code.
   - [Development](#development)
     - [Prerequisites](#prerequisites)
       - [pipx](#pipx)
+      - [UV Package Manager](#uv-package-manager)
       - [Pre-commit](#pre-commit)
     - [Activate virtual environment](#activate-virtual-environment)
     - [Install dependencies](#install-dependencies)
     - [Migrations](#migrations)
     - [Create superuser](#create-superuser)
     - [Run the server](#run-the-server)
+  - [Package Management with UV](#package-management-with-uv)
+    - [Adding New Dependencies](#adding-new-dependencies)
+    - [Benefits of UV](#benefits-of-uv)
+    - [Updating Dependencies](#updating-dependencies)
+    - [Other Useful UV Commands](#other-useful-uv-commands)
   - [Privacy and Data Protection Guidelines](#privacy-and-data-protection-guidelines)
 
 ## Community Discussions
@@ -65,6 +71,14 @@ We also use the following tools for development.
 We recommend using [pipx](https://pypa.github.io/pipx/installation/) to
 install the development tools.
 
+#### UV Package Manager
+
+We use [uv](https://github.com/astral-sh/uv), a modern Python package manager built for speed and reliability. Install it using pipx:
+
+```sh
+pipx install uv
+```
+
 #### Pre-commit
 
 We use pre-commit to run various code quality commands prior to each commit.
@@ -85,6 +99,12 @@ pre-commit install
 
 Whenever you develop, make sure you are in the project's virtual environment.
 
+Create a virtual environment using UV:
+
+```sh
+uv venv .venv
+```
+
 Linux / OSX:
 
 ```sh
@@ -99,11 +119,18 @@ Windows:
 
 ### Install dependencies
 
-Once you have the above prerequisites installed, install the project development
-dependencies as follows.
+Once you have the above prerequisites installed, install the project dependencies using UV.
+
+For production dependencies:
 
 ```sh
-pip install -r requirements.dev.txt
+uv sync
+```
+
+For development dependencies (includes testing tools):
+
+```sh
+uv sync --dev
 ```
 
 ### Migrations
@@ -139,6 +166,66 @@ When all migrations are applied and you have a superuser, run the server as foll
 python manage.py runserver
 ```
 
+## Package Management with UV
+
+### Adding New Dependencies
+
+To add a new dependency to the project:
+
+```sh
+# Add a regular dependency
+uv add package-name
+
+# Add a development dependency
+uv add --dev package-name
+
+# Add a dependency with a specific version
+uv add "package-name>=1.0,<2.0"
+```
+
+These commands will automatically update your pyproject.toml file and create/update the lock file.
+
+### Benefits of UV
+
+UV provides several advantages over traditional package management tools:
+
+- **Speed**: UV is dramatically faster at resolving and installing dependencies
+- **Reliability**: Consistent installations across environments with lock file support
+- **Dependency Groups**: Cleaner separation between production and development dependencies
+- **Modern Features**: Native support for PEP 517/518 standards with pyproject.toml
+- **Unified Interface**: Single tool for Python version management and package management
+
+### Updating Dependencies
+
+To update dependencies to their latest compatible versions:
+
+```sh
+# Update all dependencies
+uv sync --upgrade
+
+# Update specific dependency
+uv add --upgrade package-name
+```
+
+### Other Useful UV Commands
+
+```sh
+# View dependency tree
+uv tree
+
+# Lock dependencies without installing
+uv lock
+
+# Run a script within the project environment
+uv run python manage.py runserver
+
+# Check for outdated packages
+uv list --outdated
+
+# Remove a dependency
+uv remove package-name
+```
+
 ## Privacy and Data Protection Guidelines
 
 As an open-source community committed to upholding the highest standards of privacy and data security, we align our practices with principles derived from the General Data Protection Regulation (GDPR) and other similar privacy frameworks. While some GDPR principles are more relevant at an organizational level, many can be directly applied to software development, especially in features involving user data. Below are key guidelines that contributors should follow:

dev.py

@@ -5,3 +5,25 @@ description = "Caregiving visualization tool to promote wellness in elder-care c
 authors = ["Brylie Christopher Oxley <[email protected]>"]
 license = "EUPL-1.2"
 readme = "README.md"
+dependencies = [
+    "crispy-bootstrap5>=2023.10,<2024.0",
+    "django>=5.0,<6.0",
+    "django-crispy-forms>=2.1,<3.0",
+    "django-debug-toolbar>=4.2.0,<5.0",
+    "django-environ>=0.11.2,<1.0",
+    "faker>=21.0.0,<22.0",
+    "numpy>=2.2.4<3.0.0",
+    "pandas>=2.2.3",
+    "plotly>=5.18.0,<6.0",
+    "psycopg2-binary>=2.9.9,<3.0",
+    "shortuuid>=1.0.11,<2.0",
+    "whitenoise>=6.6.0,<7.0",
+]
+
+[dependency-groups]
+dev = [
+    "coverage>=7.3.3,<8.0",
+    "factory-boy>=3.3.0,<4.0",
+    "pytest>=7.4.3,<8.0",
+    "pytest-django>=3.5.1,<4.0",
+]