feat: python project setup

Author: ymarcon

.github/workflows/python-package.yml

@@ -0,0 +1,33 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python package
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12"]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install poetry
+        python -m poetry install
+    # - name: Test with pytest
+    #   run: |
+    #     python -m poetry run pytest

Dockerfile

@@ -0,0 +1,16 @@
+FROM python:3.12.9-bookworm
+ENV POETRY_VERSION=1.8.4
+RUN pip install "poetry==$POETRY_VERSION"
+# ENV PYTHONPATH="$PYTHONPATH:/app"
+
+WORKDIR /app
+
+COPY poetry.lock pyproject.toml /app/
+RUN poetry config installer.max-workers 10 && \
+    poetry config virtualenvs.create false && \
+    apt-get update && apt-get install -y g++ && \
+    poetry install --no-interaction --no-root
+
+COPY rock_spawner /app/rock_spawner
+
+ENTRYPOINT sh start.sh

Makefile

@@ -0,0 +1,25 @@
+env_path=.env
+
+build:
+	poetry build
+
+install:
+	poetry install
+
+update:
+	poetry lock
+
+#test:
+#	poetry run pytest -s
+
+shell:
+	poetry shell
+
+run:
+	poetry run dotenv -f "$(env_path)" run uvicorn rock_spawner.main:app --reload --port 8086
+
+#lint:
+#	poetry run pre-commit run --all-files
+
+docker-build:
+	docker build --no-cache=true -t obiba/rock-spawner:snapshot .

README.md

@@ -1,2 +1,22 @@
 # rock-spawner
-Rock server pod spawner in a Kubernetes environment
+
+OBiBa/Rock server pod spawner in a Kubernetes environment. This application runs and manages on-demand Rock servers, for single client usage. Allows K8s cluster to use minimal resources, and to always start a R session from a clean environment.
+
+## Development
+
+```sh
+make install
+make run
+```
+
+Then connect to http://localhost:8086/docs to get the API documentation.
+
+## Environment Variables
+
+```sh
+# Service authentication key
+API_KEYS=changeme
+
+# Kubernetes variables
+# ...
+```

poetry.lock

@@ -0,0 +1,22 @@
+[tool.poetry]
+name = "rock-spawner"
+version = "0.1.0"
+description = "OBiBa/Rock server pod spawner in a Kubernetes environment"
+authors = ["Yannick Marcon <[email protected]>"]
+license = "GPLv3"
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.12"
+fastapi = "^0.115.11"
+kubernetes = "^32.0.1"
+pydantic-settings = "^2.8.1"
+uvicorn = "^0.34.0"
+
+
+[tool.poetry.group.dev.dependencies]
+python-dotenv = {extras = ["cli"], version = "^1.0.1"}
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

pyproject.toml

@@ -0,0 +1,29 @@
+from fastapi import HTTPException, status, Security
+from fastapi.security import APIKeyHeader
+from .config import config
+
+API_KEYS = config.API_KEYS.split(",")
+
+api_key_header = APIKeyHeader(name="x-api-key", auto_error=False)
+
+
+def get_api_key(
+    api_key_header: str = Security(api_key_header),
+) -> str:
+    """Retrieve and validate an API key from the query parameters or HTTP header.
+
+    Args:
+        api_key_header: The API key passed in the HTTP header.
+
+    Returns:
+        The validated API key.
+
+    Raises:
+        HTTPException: If the API key is invalid or missing.
+    """
+    if api_key_header in API_KEYS:
+        return api_key_header
+    raise HTTPException(
+        status_code=status.HTTP_401_UNAUTHORIZED,
+        detail="Invalid or missing API Key",
+    )

rock_spawner/auth.py

@@ -0,0 +1,15 @@
+from pydantic_settings import BaseSettings
+from functools import lru_cache
+
+
+class Config(BaseSettings):
+
+    API_KEYS: str
+
+
+@lru_cache()
+def get_config():
+    return Config()
+
+
+config = get_config()

rock_spawner/config.py

@@ -0,0 +1,46 @@
+from fastapi import FastAPI, Depends, status, HTTPException
+from fastapi.middleware.cors import CORSMiddleware
+from .config import config
+from logging import basicConfig, INFO, DEBUG
+from pydantic import BaseModel
+#from .views.companies import router as companies_router
+
+basicConfig(level=DEBUG)
+
+app = FastAPI()
+
+origins = ["*"]
+
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=origins,
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"],
+)
+
+class HealthCheck(BaseModel):
+    """Response model to validate and return when performing a health check."""
+    status: str = "OK"
+
+@app.get(
+    "/healthz",
+    tags=["Healthcheck"],
+    summary="Perform a Health Check",
+    response_description="Return HTTP Status Code 200 (OK)",
+    status_code=status.HTTP_200_OK,
+    response_model=HealthCheck,
+)
+async def get_health(
+) -> HealthCheck:
+    """
+    Endpoint to perform a healthcheck on for kubenernetes liveness and
+    readiness probes.
+    """
+    return HealthCheck(status="OK")
+
+# app.include_router(
+#     companies_router,
+#     prefix="/company",
+#     tags=["Companies"],
+# )

rock_spawner/main.py

@@ -0,0 +1 @@
+uvicorn --host=0.0.0.0 --timeout-keep-alive=0 rock_spawner.main:app --reload