feat: color logging

Author: albertotb

.github/workflows/pytest-all.yml

@@ -0,0 +1,29 @@
+name: pytest-all
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+    inputs:
+      debug_enabled:
+        type: boolean
+        description: "Run with tmate debugging enabled"
+        required: false
+        default: false
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  pytest-all:
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    uses: Komorebi-AI/github-actions/.github/workflows/pytest-uv.yml@main
+    with:
+      uv-version: 0.8.0
+      python-version: ${{ matrix.python-version }}
+      debug-enabled: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}

Dockerfile

@@ -36,4 +36,4 @@ ENV PATH="/app/.venv/bin:$PATH"
 WORKDIR /app
 
 # Run the FastAPI application by default
-CMD ["uvicorn", "template.api:app", "--host", "0.0.0.0", "--port", "80"]
+CMD ["uvicorn", "template.api:app", "--host", "0.0.0.0", "--port", "80", "--log-config", "log_conf.yaml"]

Makefile

@@ -1,5 +1,5 @@
 .ONESHELL:
-.PHONY: install hooks hooks-update ruff test test-api docker build run debug attach push
+.PHONY: install hooks hooks-update ruff test test-all test-api docker build run debug attach push
 
 SHELL=/bin/bash
 DOCKER_IMG_NAME=ghcr.io/komorebi-ai/python-template
@@ -35,8 +35,15 @@ ruff:
 test:
 	$(RUN) pytest
 
+# For libraries we may want to test in all supported Python versions
+test-all:
+	$(RUN) --python 3.9 --all-extras --with . pytest
+	$(RUN) --python 3.10 --all-extras --with . pytest
+	$(RUN) --python 3.11 --all-extras --with . pytest
+	$(RUN) --python 3.12 --all-extras --with . pytest
+
 test-api:
-	uvx --from httpie http GET localhost:6000
+	uvx --from httpie http localhost:7000
 
 docker: build run
 

README.md

@@ -140,3 +140,23 @@ make ruff
 ```{bash}
 make test
 ```
+
+#### Test API
+
+1. Install `httpie` globally:
+
+   ```{bash}
+   uv tool install httpie
+   ```
+
+2. Send GET request:
+
+   ```{bash}
+   http localhost:7000
+   ```
+
+3. Send POST request:
+
+   ```{bash}
+   http localhost:7000/predict input=5
+   ```

log_conf.yaml

@@ -0,0 +1,78 @@
+version: 1
+disable_existing_loggers: False
+
+formatters:
+  default:
+    (): colorlog.ColoredFormatter
+    format: "%(asctime_log_color)s%(asctime)s%(reset)s - %(name_log_color)s%(name)s%(reset)s - %(log_color)s%(levelname)s%(reset)s - %(message_log_color)s%(message)s%(reset)s"
+    log_colors:
+      DEBUG: white
+      INFO: green
+      WARNING: yellow
+      ERROR: red
+      CRITICAL: bold_red
+    secondary_log_colors:
+      asctime:
+        DEBUG: cyan
+        INFO: cyan
+        WARNING: cyan
+        ERROR: cyan
+        CRITICAL: cyan
+      name:
+        DEBUG: blue
+        INFO: blue
+        WARNING: blue
+        ERROR: blue
+        CRITICAL: blue
+      message:
+        DEBUG: white
+        INFO: white
+        WARNING: white
+        ERROR: white
+        CRITICAL: white
+
+  access:
+    (): colorlog.ColoredFormatter
+    format: "%(asctime_log_color)s%(asctime)s%(reset)s - %(name_log_color)s%(name)s%(reset)s - %(log_color)s%(levelname)s%(reset)s - %(message_log_color)s%(message)s%(reset)s"
+    log_colors:
+      INFO: green
+      ERROR: red
+    secondary_log_colors:
+      asctime:
+        INFO: cyan
+        ERROR: cyan
+      name:
+        INFO: blue
+        ERROR: blue
+      message:
+        INFO: white
+        ERROR: white
+
+handlers:
+  default:
+    class: logging.StreamHandler
+    formatter: default
+    stream: ext://sys.stderr
+
+  access:
+    class: logging.StreamHandler
+    formatter: access
+    stream: ext://sys.stdout
+
+loggers:
+  uvicorn.error:
+    level: INFO
+    handlers:
+      - default
+    propagate: no
+
+  uvicorn.access:
+    level: INFO
+    handlers:
+      - access
+    propagate: no
+
+root:
+  level: WARNING
+  handlers:
+    - default

pyproject.toml

@@ -16,6 +16,7 @@ dependencies = [
     "fastapi",
     "uvicorn",
     "typer-slim",
+    "colorlog>=6.9.0",
 ]
 
 [project.urls]

template/api.py

@@ -1,23 +1,58 @@
+# Use A | B syntax for Union types in Python 3.9
 from __future__ import annotations
 
+import logging
+
 from fastapi import FastAPI
+from pydantic import BaseModel
 
 from template.main import __version__
 
+logger = logging.getLogger(__name__)
+
+# Overwrite root log level from `log_conf.yaml`
+logger.setLevel(logging.DEBUG)
+
 app = FastAPI()
 
 
+class Request(BaseModel):
+    """Data model for the request body."""
+
+    input: int
+
+
+class Response(BaseModel):
+    """Data model for the response body."""
+
+    output: int
+
+
 @app.get("/")
 def read_root() -> dict[str, str]:
     """Check API version."""
+    logger.debug("DEBUG")
+    logger.warning("WARNING")
+    logger.info("INFO")
+    logger.error("ERROR")
+    logger.critical("CRITICAL")
+
     return {"template-api": f"version {__version__}"}
 
 
+@app.post("/predict")
+def predict(request: Request) -> Response:
+    """Mock prediction endpoint."""
+    return {"output": request.input}
+
+
 if __name__ == "__main__":
     import sys
 
     import uvicorn
 
-    port = 7654 if len(sys.argv) < 2 else int(sys.argv[1])
+    port = 7000 if len(sys.argv) < 2 else int(sys.argv[1])
     host = "127.0.0.1" if len(sys.argv) < 3 else sys.argv[2]
-    uvicorn.run("api:app", host=host, port=port, reload=True)
+    uvicorn.run(
+        "api:app", host=host, port=port, reload=True, log_config="log_conf.yaml"
+    )

template/main.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python
-from __future__ import annotations  # noqa: I001
+# Use A | B syntax for Union types in Python 3.9
+from __future__ import annotations
 
 from importlib.metadata import PackageNotFoundError, version