chore: Update deps and make project refacto (#80)

- Use UV instead of poetry
- Configure devcontainer
- Update doc
- Use lifespan instead app_event in fastapi application

Author: vvatelot

.devcontainer/devcontainer.json

@@ -0,0 +1,35 @@
+{
+    "name": "Fastapi Boilerplate container",
+    "image": "mcr.microsoft.com/devcontainers/python:3.12",
+    "postCreateCommand": "uv sync --all-groups --frozen && uv run prisma migrate dev --schema database/schema.prisma",
+    "features": {
+        "ghcr.io/va-h/devcontainers-features/uv": {
+            "version": "latest"
+        }
+    },
+    "containerEnv": {
+        "UV_LINK_MODE": "copy",
+        "TZ": "Europe/Paris"
+    },
+    "forwardPorts": [
+        8000
+    ],
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "charliermarsh.ruff",
+                "mhutchie.git-graph",
+                "ms-azuretools.vscode-docker",
+                "ms-python.mypy-type-checker",
+                "samuelcolvin.jinjahtml",
+                "tamasfe.even-better-toml",
+                "ue.alphabetical-sorter",
+                "yzhang.markdown-all-in-one",
+                "esbenp.prettier-vscode"
+            ],
+            "settings": {
+                "python.defaultInterpreterPath": "/usr/local/bin/python"
+            }
+        }
+    }
+}

.dockerignore

@@ -6,5 +6,6 @@
 !database
 !docker
 !pyproject.toml
-!poetry.lock
-!main.py
+!uv.lock
+!main.py
+!README.md

.vscode/settings.json

@@ -0,0 +1,22 @@
+{
+    "[python]": {
+        "editor.formatOnSave": true,
+        "editor.defaultFormatter": "charliermarsh.ruff",
+    },
+    "ruff.organizeImports": true,
+    "ruff.importStrategy": "fromEnvironment",
+    "editor.codeActionsOnSave": {
+        "source.organizeImports.ruff": "explicit",
+        "source.unusedImports": "explicit"
+    },
+    "python.analysis.autoSearchPaths": true,
+    "python.analysis.extraPaths": [
+        "${workspaceFolder}"
+    ],
+    "python.analysis.typeCheckingMode": "basic",
+    "python.languageServer": "Pylance",
+    "python.analysis.autoImportCompletions": true,
+    "files.associations": {
+        "**/templates/**/*.html": "jinja-html"
+    }
+}

README.md

@@ -9,7 +9,7 @@ For the frontend, it uses [Bootstrap](https://getbootstrap.com/) and [HTMX](http
 ## Requirements
 
 - [Docker](https://docs.docker.com/get-docker/) and [docker-compose](https://docs.docker.com/compose/) v2 for running the project
-- [Python 3.10+](https://www.python.org/) and [Poetry](https://python-poetry.org/) for development
+- [Python 3.12+](https://www.python.org/) and [uv](https://docs.astral.sh/uv/) for development
 
 ## Quickstart
 
@@ -18,27 +18,34 @@ For the frontend, it uses [Bootstrap](https://getbootstrap.com/) and [HTMX](http
 ```bash
 cp docker-compose.override.yml.dist docker-compose.override.yml 
 docker compose up
+
+# Service is running on http://localhost:8000
 ```
 
 ### Development
 
+
+To improve development experience, a devcontainer configuration is available. To setup a development environment, you can simply use [Vscode Devcontainer](https://youtu.be/b1RavPr_878). Once the devcontainer is up, just run the command `uv run fastapi dev ./app/main.py` to start the dev server that will be available on [localhost:8000](http://localhost:8000)
+
+Else, you can follow those steps to configure the development environment on your host:
+
+
 ```bash
 # Install dependencies
-poetry install
+uv sync --all-groups --frozen
+
+# Install prisma client
+uv run prisma migrate dev --schema database/schema.prisma
 
 # Run the project
-poetry run uvicorn app.main:app --reload
+uv run fastapi dev ./app/main.py
 ```
 
 ### Project quality
 
 ```bash
-# Run tests
-poetry run pytest
-
 # Run linters
-poetry run ruff . --fix
-poetry run black .
+uv run ruff check . --fix
 ```
 
 ## Application structure

app/__init__.py

@@ -1,3 +1,5 @@
+from contextlib import asynccontextmanager
+
 from fastapi import FastAPI
 from fastapi.staticfiles import StaticFiles
 
@@ -6,20 +8,19 @@
 from database.engine import db
 
 
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    await db.connect()
+    yield
+    await db.disconnect()
+
+
 def init_app():
-    app = FastAPI(debug=DEBUG)
+    app = FastAPI(debug=DEBUG, lifespan=lifespan)
 
     app.mount("/static", StaticFiles(directory="static"), name="static")
     app.include_router(router)
 
-    @app.on_event(event_type="startup")
-    async def on_startup():
-        await db.connect()
-
-    @app.on_event(event_type="shutdown")
-    async def on_shutdown():
-        await db.disconnect()
-
     return app
 
 

app/main.py

@@ -5,7 +5,7 @@ services:
       dockerfile: ./docker/dockerfile
     restart: always
     ports:
-      - "8001:8000"
+      - "8000:8000"
     environment:
       DEBUG: False
       TZ: Europe/Paris

docker-compose.override.yml.dist

@@ -1,14 +1,8 @@
-FROM python:3.11-slim as requirements-stage
-WORKDIR /tmp
-RUN pip install poetry
-COPY ./pyproject.toml ./poetry.lock /tmp/
-RUN poetry export --output=requirements.txt --without-hashes
-
-FROM python:3.11-slim
+FROM python:3.12-slim
 WORKDIR /code
-COPY --from=requirements-stage /tmp/requirements.txt /code/requirements.txt
-RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt
-RUN pip install asyncpg
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /bin/uv
+COPY ./uv.lock ./pyproject.toml ./README.md /code/
+RUN uv sync --frozen
 COPY ./ /code/
 COPY ./docker/entrypoint.sh /usr/bin/entrypoint
 RUN chmod +x /usr/bin/entrypoint

docker-compose.yml

@@ -1,4 +1,4 @@
 #!/bin/sh
 
-prisma migrate dev --schema database/schema.prisma
-gunicorn app.main:app --timeout 0 --workers 4 --worker-class uvicorn.workers.UvicornWorker --bind 0.0.0.0:8000 --forwarded-allow-ips="*"
+uv run prisma migrate dev --schema database/schema.prisma
+uv run fastapi run ./app/main.py