refactor: update the project

.gitignore

@@ -1,10 +1,33 @@
-venv/
-.mypy_cache/
-.vscode/
-
-__pycache__/
+# Application
 data/
 
 .DS_Store
 readme.html
 minesweeper.md
+
+# Environnement
+venv/
+.venv/
+.env
+
+# Tools
+.tox/
+.ruff_cache
+
+# IDEs
+.vscode/
+
+.fleet/
+
+# Builds
+*.egg-info/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# MacOS
+**/.DS_Store
+
+# Exceptions

Dockerfile

@@ -1,35 +1,32 @@
 # syntax=docker/dockerfile-upstream:master-labs
 
-FROM python:3.12.0-alpine as build
+FROM python:3.12-alpine AS build
+ARG EXTRA_DEBUG=""
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /bin/uv
 WORKDIR /app
-RUN python -m venv /opt/venv
-ENV PATH="/opt/venv/bin:$PATH"
-COPY ./resources ./
-RUN --mount=type=cache,target=/var/cache/apk/ \
-    --mount=type=cache,target=/root/.cache/pip \
-    --mount=type=bind,source=requirements.txt,target=requirements.txt \
+RUN --mount=type=cache,target=/var/cache/apk \
+    --mount=type=cache,target=/root/.cache/uv \
+    --mount=type=bind,source=uv.lock,target=uv.lock \
+    --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
     : \
-    && apk add gcc musl-dev linux-headers git \
-    && pip install -U pip \
-    && pip install -U -r requirements.txt \
+    && apk update && apk add gcc musl-dev linux-headers git  \
+    && uv sync --no-dev --locked $EXTRA_DEBUG \
     && :
 
-FROM python:3.12.0-alpine as base
-COPY --parents --from=build /opt/venv /
+FROM python:3.12-alpine AS base
+# https://docs.docker.com/reference/dockerfile/#copy---parents
 WORKDIR /app
+COPY --parents --from=build /app/.venv /
+COPY --parents ./resources ./
 COPY ./src ./
-COPY --parents  ./resources ./
-ENV PATH="/opt/venv/bin:$PATH"
+ENV PATH="/app/.venv/bin:$PATH"
 ENV PYTHONUNBUFFERED=0
 
-FROM base as production
-ENV GITHUB_PROFILE_URL="https://github.com/AiroPi"
+FROM base AS production
 CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "80"]
 
-
-FROM base as debug
+FROM base AS debug
+COPY ./debug_pages /app/debug_pages
 ENV DEBUG=1
 ENV LOG_LEVEL=DEBUG
-ENV GITHUB_PROFILE_URL="http://localhost/readme.md"
-COPY ./readme.html ./
 CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "80", "--reload"]

compose.yml

@@ -1,11 +1,10 @@
-version: "3"
-
 services:
   readme-backend:
-    # image: airopi/readme-backend
     build:
       dockerfile: ./Dockerfile
-      target: production
+      target: debug
+      args:
+        EXTRA_DEBUG: "--extra debug"
     develop:
       watch:
         - action: sync
@@ -19,5 +18,7 @@ services:
           target: /app/readme.example.html
         - action: rebuild
           path: ./requirements.txt
+    ports:
+      - 80:80
     environment:
-      - GITHUB_PROFILE_URL="https://github.com/AiroPi"
+      GITHUB_PROFILE_URL: "http://localhost/readme.md"

deploy/compose.yml

@@ -0,0 +1,5 @@
+services:
+  readme-backend:
+    image: ghcr.io/airopi/readme-backend:master
+    environment:
+      GITHUB_PROFILE_URL: "https://github.com/AiroPi"

pyproject.toml

@@ -1,24 +1,61 @@
+# https://docs.astral.sh/uv/concepts/projects/config/#configuring-projects
+[project]
+name = "readme-backend"
+version = "1.0"
+requires-python = ">=3.12"
+dependencies = [
+    #
+    "fastapi",
+    "uvicorn",
+    "Pillow",
+    "connect4.py==1.0.3",
+    "minesweeper @ git+https://github.com/AiroPi/minesweeper",
+]
+
+
+[project.optional-dependencies]
+debug = ["markdown"]
+
+# https://docs.astral.sh/uv/concepts/projects/
+[tool.uv]
+dev-dependencies = [
+    # "uv",
+    "pyright",
+    "ruff",
+    "tox",
+    "tox-uv",
+    "types-Pillow",
+]
+
+
+# https://microsoft.github.io/pyright/#/
+[tool.pyright]
+typeCheckingMode = "strict"
+
+
+# https://tox.wiki/en/latest/
 [tool.tox]
-legacy_tox_ini = """
-[tox]
-skipsdist = true
+envlist = ["py312"]
+
+[tool.tox.env_run_base]
+runner = "uv-venv-lock-runner"
+description = "run all checks on the code"
+extras = ["dev"]
+commands = [
+    #fmt
+    ["ruff", "format", "--check", "src"],
+    ["ruff", "check", "src"],
+    ["pyright", "src"],
+]
 
-[testenv]
-deps = 
-    -r requirements.txt
-    -r requirements.dev.txt
-commands =
-    # pytest
-    ruff format --check src
-    ruff check src
-    pyright src/
-"""
 
+# https://docs.astral.sh/ruff/
 [tool.ruff]
 line-length = 120
 indent-width = 4
 target-version = "py312"
 src = ["src"]
+exclude = ["bin"]
 
 [tool.ruff.lint]
 select = [
@@ -59,9 +96,9 @@ select = [
 ]
 
 ignore = [
-    "E501",   # line too long (we relate on the formater)
-    "N818",   # Error suffix for exceptions names
-    "PIE796", # Enum contains duplicate value
+    "E501", # line too long (we relate on the formater)
+    "N818", # Error suffix for exceptions names
+    # "PIE796", # Enum contains duplicate value
     "TRY003", # Avoid specifying long messages outsides the exception class
     "ISC001", # To avoid conflicts with the formatter
 ]
@@ -74,7 +111,3 @@ skip-magic-trailing-comma = false
 
 [tool.ruff.lint.isort]
 combine-as-imports = true
-
-[tool.setuptools.dynamic]
-dependencies = { file = ["requirements.in"] }
-optional-dependencies.dev = { file = ["requirements.dev.in"] }

src/main.py

@@ -1,7 +1,7 @@
 import os
 
 from fastapi import FastAPI
-from fastapi.responses import FileResponse, RedirectResponse
+from fastapi.responses import HTMLResponse, RedirectResponse
 
 from routers import connect4_router, minesweeper_router
 
@@ -21,4 +21,10 @@ def read_root():
 
     @app.get("/readme.md")
     def get_readme():
-        return FileResponse("./readme.html")
+        from markdown import markdown
+
+        with open("./debug_pages/minesweeper.md") as f:
+            markdown_text = f.read()
+        return HTMLResponse(markdown(markdown_text))
+
+        # return FileResponse("./readme.html")

src/routers/minesweeper_router.py

@@ -75,10 +75,7 @@ def play(i: int, j: int):
         return RedirectResponse(GITHUB_PROFILE_URL)
 
     if flag_mode:
-        if (i, j) in game.flags:
-            game.flags.remove((i, j))
-        else:
-            game.add_flag(i, j)
+        game.toggle_flag(i, j)
     else:
         if (i, j) not in game.flags:
             game.play(i, j)