Chore - Use uv workspaces + Group docker config

.python-version

@@ -0,0 +1 @@
+3.12

Makefile

@@ -16,9 +16,6 @@ help:
 
 # Setup
 
-sync:
-	uv sync
-
 rebuild:
 	docker compose down --rmi local -v
 	docker compose build
@@ -29,12 +26,15 @@ run:
 
 # Contribute
 
+sync:
+	uv sync
+
 format:
 	uv run ruff check --fix .
 	uv run ruff format .
 
 lint:
-	uv run ruff check src
+	uv run ruff check
 	uv run ruff format --check
 
 typecheck:
@@ -43,8 +43,8 @@ typecheck:
 
 check: lint typecheck
 
-
 test:
 	uv run pytest
+	uv run --directory apps/olapi pytest
 
-ci: sync lint check test
+ci: sync lint typecheck test

README.md

@@ -22,7 +22,7 @@ make rebuild
 
 Then:
 
-* **Requests on API**: `uv run scripts/request_api.py`
+* **Requests on API**: `uv run --directory apps/olapi python -m scripts.request_api`
 * **See swagger**: [http://localhost:8000/docs](http://localhost:8000/docs)
 * **Check keycloak users**: [http://localhost:8080/admin/master/console/#/olapi/users](http://localhost:8080/admin/master/console/#/olapi/users)
     * username=admin
@@ -55,32 +55,37 @@ Then:
 
 ### Structure
 
+Using [uv workspaces](https://docs.astral.sh/uv/concepts/projects/workspaces/):
+
 ```
   .
   ├── Makefile
   ├── README.md
-  ├── README_DEV.md
+  ├── CONTRIBUTING.md
   ├── docker-compose.yml
   ├── pyproject.toml
   ├── ...
-  ├── keycloak/  # Settings for keycloak server
-  │   └── ...
-  ├── scripts/
-  │   └── ...
-  └── src/
-      ├── authentication/        # Keycloak client
-      │   └── ...
-      └── olapi/                 # FastAPI application
-          ├── __init__.py
-          ├── main.py
-          ├── settings.py
-          ├── ...
-          ├── models/            # tables
-          │   ├── ...
-          ├── routers/           # endpoints
+  ├── docker/                    # docker stack config
+  │   ├── Dockerfile             # api image build
+  │   └── keycloak/              # keycloak realm import
+  │       └── ...
+  ├── apps/
+  │   └── olapi/                 # FastAPI application (flat uv-app)
+  │       ├── main.py
+  │       ├── settings.py
+  │       ├── ...
+  │       ├── models/            # tables
+  │       ├── routers/           # endpoints
+  │       ├── dtos/              # dtos
+  │       ├── scripts/           # API usage scripts
+  │       ├── tests/
+  │       └── pyproject.toml
+  └── libs/
+      └── authentication/        # Keycloak client (packaged library)
+          ├── src/authentication/
           │   └── ...
-          └── dtos/              # dtos
-              └── ...
+          ├── tests/
+          └── pyproject.toml
 ```
 
 ### Shortcuts

apps/olapi/README.md

@@ -0,0 +1,27 @@
+# olapi
+
+The Social Media API application (FastAPI).
+
+This is a flat [uv-app](https://docs.astral.sh/uv/concepts/projects/init/#applications):
+modules live directly under this directory and are imported relative to it (e.g.
+`from main import app`). The app is not packaged or installed.
+
+## Run
+
+From the repository root:
+
+```bash
+make run        # docker compose up (postgres + keycloak + api)
+```
+
+Or directly with uvicorn from this directory:
+
+```bash
+uv run uvicorn main:app --reload
+```
+
+## Test
+
+```bash
+uv run --directory apps/olapi pytest
+```

src/olapi/auth.py → apps/olapi/auth.py

@@ -6,9 +6,9 @@
 
 from authentication import exceptions as auth_exceptions
 from authentication.keycloak import KeycloakClient
-from olapi.database import get_session
-from olapi.models.user import UserModel
-from olapi.settings import settings
+from database import get_session
+from models.user import UserModel
+from settings import settings
 
 oauth2_scheme = OAuth2PasswordBearer(tokenUrl="login", auto_error=False)
 auth_client = KeycloakClient(

src/olapi/database.py → apps/olapi/database.py

@@ -3,7 +3,7 @@
 from sqlalchemy import create_engine
 from sqlalchemy.orm import Session, sessionmaker
 
-from olapi.settings import settings
+from settings import settings
 
 # TODO: use context managers ?
 

src/olapi/dtos/user.py → apps/olapi/dtos/user.py

@@ -3,7 +3,7 @@
 
 from pydantic import BaseModel, EmailStr, Field
 
-from olapi.models.user import UserModel
+from models.user import UserModel
 
 
 class UserCreatePayload(BaseModel):

src/olapi/main.py → apps/olapi/main.py

@@ -4,11 +4,11 @@
 
 from fastapi import APIRouter, Depends, FastAPI
 
-from olapi.auth import check_authentication
-from olapi.database import engine
-from olapi.models.base import BaseModel
-from olapi.routers import auth, temporary
-from olapi.settings import LOGGING_CONFIG
+from auth import check_authentication
+from database import engine
+from models.base import BaseModel
+from routers import auth, temporary
+from settings import LOGGING_CONFIG
 
 dictConfig(LOGGING_CONFIG)
 

src/olapi/models/user.py → apps/olapi/models/user.py

@@ -3,7 +3,7 @@
 from sqlalchemy import DateTime, String, func
 from sqlalchemy.orm import Mapped, mapped_column
 
-from olapi.models.base import BaseModel
+from models.base import BaseModel
 
 
 class UserModel(BaseModel):

apps/olapi/pyproject.toml

@@ -0,0 +1,44 @@
+[project]
+name = "olapi"
+version = "0.0.1"
+description = "Social Media API"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "fastapi>=0.110",
+    "uvicorn[standard]>=0.27",
+    "sqlalchemy>=2.0",
+    "psycopg[binary]>=3.1",
+    "pydantic[email]>=2.6",
+    "python-jose[cryptography]>=3.3",
+    "python-ulid>=2.2",
+    "httpx2>=2.3",
+    "authentication",
+]
+
+# Flat uv-app: no [build-system], so the app is not built or installed as a
+# package. Its modules are imported relative to this directory (see pythonpath).
+
+[tool.uv.sources]
+authentication = { workspace = true }
+
+[tool.pytest.ini_options]
+pythonpath = ["."]
+
+[tool.ruff]
+extend = "../../pyproject.toml"
+
+# The app is flat, so isort can't auto-detect its own modules; the authentication
+# workspace library is also a first-party concern. Group them together.
+[tool.ruff.lint.isort]
+known-first-party = [
+    "authentication",
+    "auth",
+    "conftest",
+    "database",
+    "dtos",
+    "main",
+    "models",
+    "routers",
+    "settings",
+]

src/olapi/routers/auth.py → apps/olapi/routers/auth.py

@@ -6,12 +6,12 @@
 from sqlalchemy.orm import Session
 from ulid import ULID
 
+from auth import auth_client
 from authentication import exceptions as auth_exceptions
-from olapi.auth import auth_client
-from olapi.database import get_session
-from olapi.dtos.auth import Credentials, TokenResponse
-from olapi.dtos.user import User, UserCreatePayload
-from olapi.models.user import UserModel
+from database import get_session
+from dtos.auth import Credentials, TokenResponse
+from dtos.user import User, UserCreatePayload
+from models.user import UserModel
 
 logger = logging.getLogger(__name__)
 

src/olapi/routers/temporary.py → apps/olapi/routers/temporary.py

@@ -1,7 +1,7 @@
 from fastapi import APIRouter, Depends
 
-from olapi.auth import get_user
-from olapi.models.user import UserModel
+from auth import get_user
+from models.user import UserModel
 
 router = APIRouter()
 

scripts/request_api.py → apps/olapi/scripts/request_api.py

@@ -3,8 +3,8 @@
 import httpx2
 
 from authentication.keycloak import check_response
-from olapi.dtos.auth import Credentials, TokenResponse
-from olapi.dtos.user import User, UserCreatePayload
+from dtos.auth import Credentials, TokenResponse
+from dtos.user import User, UserCreatePayload
 
 logger = logging.getLogger(__name__)
 

tests/conftest.py → apps/olapi/tests/conftest.py

@@ -6,10 +6,10 @@
 from sqlalchemy.orm import Session, sessionmaker
 from sqlalchemy.pool import StaticPool
 
-from olapi.auth import check_authentication
-from olapi.database import get_session
-from olapi.main import app
-from olapi.models.base import BaseModel
+from auth import check_authentication
+from database import get_session
+from main import app
+from models.base import BaseModel
 
 TEST_AUTH_ID = "test-auth-id"
 

tests/test_temporary.py → apps/olapi/tests/test_temporary.py

@@ -1,8 +1,8 @@
-from conftest import TEST_AUTH_ID
 from fastapi.testclient import TestClient
 from sqlalchemy.orm import Session
 
-from olapi.models.user import UserModel
+from conftest import TEST_AUTH_ID
+from models.user import UserModel
 
 
 def test_get_hello(app_client: TestClient, db_session: Session):

docker-compose.yml

@@ -20,13 +20,15 @@ services:
       KC_BOOTSTRAP_ADMIN_USERNAME: admin
       KC_BOOTSTRAP_ADMIN_PASSWORD: admin
     volumes:
-      - ./keycloak:/opt/keycloak/data/import:ro
+      - ./docker/keycloak:/opt/keycloak/data/import:ro
     ports:
       - "8080:8080"
 
   api:
-    build: .
-    command: uvicorn olapi.main:app --host 0.0.0.0 --reload --reload-dir /app/src
+    build:
+      context: .
+      dockerfile: docker/Dockerfile
+    command: uvicorn main:app --host 0.0.0.0 --reload --reload-dir /app/apps/olapi
     depends_on:
       postgres:
         condition: service_healthy
@@ -35,4 +37,4 @@ services:
     ports:
       - "8000:8000"
     volumes:
-      - ./src:/app/src
+      - ./apps/olapi:/app/apps/olapi

docker/Dockerfile

@@ -0,0 +1,18 @@
+FROM python:3.12-slim
+
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
+
+WORKDIR /app
+COPY pyproject.toml uv.lock ./
+COPY libs ./libs
+COPY apps ./apps
+
+RUN uv sync --frozen --no-dev
+
+ENV PATH="/app/.venv/bin:$PATH"
+
+# The olapi app is a flat uv-app; run it from its own directory so `main:app` resolves.
+WORKDIR /app/apps/olapi
+
+EXPOSE 8000
+CMD ["uvicorn", "main:app", "--host", "0.0.0.0"]

libs/authentication/README.md

@@ -0,0 +1,24 @@
+# authentication
+
+Keycloak authentication client library (src-layout, packaged with `uv_build`).
+
+Exposes a `KeycloakClient` and related exceptions used by workspace apps to
+register users, issue tokens, and validate them.
+
+## Use
+
+Declare it as a workspace dependency in a member's `pyproject.toml`:
+
+```toml
+dependencies = ["authentication"]
+
+[tool.uv.sources]
+authentication = { workspace = true }
+```
+
+Then import:
+
+```python
+from authentication.keycloak import KeycloakClient
+from authentication import exceptions
+```