Merge pull request #175 from duo-labs/feat/astral-uv-support

MasterKale · web-flow · commit 9189461f22d6 · 2025-11-21T15:55:16.000-08:00
Use Astral's uv and ruff
diff --git a/.editorconfig b/.editorconfig
@@ -8,5 +8,5 @@ indent_size = 2
 indent_style = space
 insert_final_newline = true
 
-[*.{py,md}]
+[*.{py,md,toml}]
 indent_size = 4
diff --git a/.github/workflows/unit_test.yml b/.github/workflows/unit_test.yml
@@ -30,21 +30,27 @@ jobs:
           - 6379:6379
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v5
+
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v6
+      with:
+          python-version-file: "pyproject.toml"
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
       with:
-        python-version: ${{ matrix.python-version }}
+          version: "0.9.9"
+
     - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pipenv
-        pipenv install --deploy --dev
+      run: uv sync --locked --all-extras --dev
+
     - name: Test with unittest
-      run: |
-        pipenv run _app/manage.py test homepage.tests
+      run: uv run python _app/manage.py test homepage.tests
       env:
         # Tests are running "locally" while Redis is in a container
         REDIS_HOSTNAME: localhost
+
     - name: Run mypy
       run: |
-        pipenv run mypy _app/homepage
+        uv run mypy _app/homepage
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,6 @@ _psql
 *.env
 .DS_Store
 _app/**/styles/*.css
+_app/.venv
+_app/pyproject.toml
+_app/uv.lock
diff --git a/.python-version b/.python-version
@@ -0,0 +1 @@
+3.10
diff --git a/Dockerfile b/Dockerfile
@@ -1,6 +1,8 @@
-# Tweak the base image by installing pipenv
+# Tweak the base image by installing uv
 FROM python:3.10-slim AS base
-RUN pip install pipenv
+
+# Install uv (https://docs.astral.sh/uv/guides/integration/docker/#installing-uv)
+COPY --from=ghcr.io/astral-sh/uv:0.9.9 /uv /uvx /bin/
 
 # Begin our actual build
 FROM base AS base1
@@ -11,13 +13,12 @@ ARG DJANGO_SECRET_KEY
 RUN mkdir -p /usr/src/app
 
 COPY ./_app /usr/src/app
-COPY Pipfile /usr/src/app/
-COPY Pipfile.lock /usr/src/app/
+COPY pyproject.toml uv.lock /usr/src/app/
 
 WORKDIR /usr/src/app
 
 # Install Python dependencies
-RUN pipenv install --system --deploy
+RUN uv sync --locked
 
 # Collect static files
-RUN python manage.py collectstatic --no-input
+RUN uv run python manage.py collectstatic --no-input
diff --git a/Pipfile b/Pipfile
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -5,9 +5,8 @@ Duo's introduction to the wonderful world of WebAuthn. Powered by [py_webauthn](
 ## Prerequisites
 
 - Docker
-- Pipenv
-  - Make sure Python3 is available
-  - Enables `pipenv install` to set up libraries locally for the editor to crawl. The Django container also uses Pipenv to install dependencies to encourage use of this new Python package management tool.
+- uv (See https://docs.astral.sh/uv/getting-started/installation/)
+  - Run `uv sync` locally to install dependencies and give the editor something to crawl
 
 ## Environmental Variable
 
diff --git a/_app/homepage/admin.py b/_app/homepage/admin.py
@@ -1,3 +1,3 @@
-from django.contrib import admin
+# from django.contrib import admin
 
 # Register your models here.
diff --git a/_app/homepage/helpers.py b/_app/homepage/helpers.py
@@ -28,4 +28,4 @@ def truncate_credential_id_to_ui_string(id: str) -> str:
         # Return the entire ID if there's nothing to truncate
         return id
 
-    return f"{id[0:truncation_length]}...{id[(0-truncation_length):]}"
+    return f"{id[0:truncation_length]}...{id[(0 - truncation_length) :]}"
diff --git a/_app/homepage/services/redis.py b/_app/homepage/services/redis.py
@@ -24,7 +24,7 @@ def store(
         *,
         key: str,
         value: Union[bytes, str, int, float],
-        expiration_seconds: Optional[int] = None
+        expiration_seconds: Optional[int] = None,
     ):
         return self._instance.set(key, value, ex=expiration_seconds)
 
diff --git a/_app/homepage/tests.py b/_app/homepage/tests.py
@@ -1,3 +1,3 @@
-from django.test import TestCase
+# from django.test import TestCase
 
 # Create your tests here.
diff --git a/_app/homepage/tests/test_view_authentication_options.py b/_app/homepage/tests/test_view_authentication_options.py
@@ -9,7 +9,6 @@ def setUp(self):
         self.client.get(reverse("index"))
 
     def test_handles_hints(self):
-
         options = self.client.post(
             self.route,
             {
diff --git a/_app/manage.py b/_app/manage.py
@@ -1,12 +1,13 @@
 #!/usr/bin/env python
 """Django's command-line utility for administrative tasks."""
+
 import os
 import sys
 
 
 def main():
     """Run administrative tasks."""
-    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'webauthnio.settings')
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "webauthnio.settings")
     try:
         from django.core.management import execute_from_command_line
     except ImportError as exc:
@@ -18,5 +19,5 @@ def main():
     execute_from_command_line(sys.argv)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()
diff --git a/_app/webauthnio/asgi.py b/_app/webauthnio/asgi.py
@@ -11,6 +11,6 @@
 
 from django.core.asgi import get_asgi_application
 
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'webauthnio.settings')
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "webauthnio.settings")
 
 application = get_asgi_application()
diff --git a/_app/webauthnio/wsgi.py b/_app/webauthnio/wsgi.py
@@ -11,6 +11,6 @@
 
 from django.core.wsgi import get_wsgi_application
 
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'webauthnio.settings')
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "webauthnio.settings")
 
 application = get_wsgi_application()
diff --git a/docker-compose.override.yml b/docker-compose.override.yml
@@ -11,7 +11,7 @@ services:
 
   django:
     # Automatically reload Gunicorn when a file changes
-    command: gunicorn webauthnio.wsgi -c gunicorn.cfg.py --reload
+    command: uv run gunicorn webauthnio.wsgi -c gunicorn.cfg.py --reload
     environment:
       - DEBUG=true
       - RP_ID=localhost
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -31,9 +31,12 @@ services:
         - DJANGO_SECRET_KEY
     depends_on:
       - redis
-    command: gunicorn webauthnio.wsgi -c gunicorn.cfg.py
+    command: uv run gunicorn webauthnio.wsgi -c gunicorn.cfg.py
     volumes:
       - ./_app:/usr/src/app
+      # uv-specific files needed for `uv run` commands to succeed
+      - ./pyproject.toml:/usr/src/app/pyproject.toml
+      - ./uv.lock:/usr/src/app/uv.lock
       # Django static files will go here so Caddy can access them
       - static_files_volume:/usr/src/app/static
     networks:
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,30 @@
+[project]
+name = "webauthn-io"
+version = "0.1.0"
+description = "Duo's introduction to the wonderful world of WebAuthn"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "dilithium-py==1.3.0",
+    "django==5.1.4",
+    "gunicorn==23.0.0",
+    "hiredis==3.3.0",
+    "redis==5.2.0",
+    "webauthn==2.8.0a1",
+]
+
+[dependency-groups]
+dev = [
+    "mypy>=1.18.2",
+    "ruff>=0.14.5",
+]
+
+[tool.ruff]
+line-length = 99
+exclude = [
+    "_app/homepage/migrations"
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
diff --git a/uv.lock b/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		`-from django.contrib import admin`
	`1`	`+# from django.contrib import admin`
`2`	`2`
`3`	`3`	`# Register your models here.`