Add initial project structure with Docker, CI/CD, and FastAPI setup

Author: faizanazim11

.devcontainer/Dockerfile

@@ -0,0 +1,10 @@
+FROM mcr.microsoft.com/devcontainers/python:dev-3.13-bookworm
+
+RUN apt-get update && apt-get install -y git && rm -rf /var/lib/apt/lists/*
+WORKDIR /example
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /usr/local/bin/uv
+ENV UV_LINK_MODE=copy
+ENV UV_PROJECT_ENVIRONMENT="/usr/local/"
+COPY . .
+RUN mkdir -p ./.vscode && uv sync --dev --prerelease=allow
+CMD ["tail", "-f", "/dev/null"]

.devcontainer/container-launch.json

@@ -0,0 +1,13 @@
+
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "App Debug",
+      "type": "debugpy",
+      "request": "launch",
+      "program": "app.py",
+      "console": "integratedTerminal"
+    }
+  ]
+}

.devcontainer/devcontainer.json

@@ -0,0 +1,66 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
+{
+    "name": "Example",
+    // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+    "dockerComposeFile": "./docker-compose.yaml",
+    "service": "example",
+    "workspaceFolder": "/example",
+    "shutdownAction": "stopCompose",
+    "forwardPorts": [
+        8002
+    ],
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "vivaxy.vscode-conventional-commits",
+                "ms-toolsai.datawrangler",
+                "mikestead.dotenv",
+                "elagil.pre-commit-helper",
+                "donjayamanne.python-extension-pack",
+                "charliermarsh.ruff",
+                "sourcery.sourcery", // Remove sourcery and sonarlint if you have less memory
+                "SonarSource.sonarlint-vscode",
+                "redhat.vscode-yaml",
+                "ms-azuretools.vscode-docker",
+                "ms-toolsai.jupyter"
+            ],
+            "settings": {
+                "[python]": {
+                    "editor.formatOnType": false,
+                    "editor.codeActionsOnSave": {
+                        "source.organizeImports.ruff": "explicit",
+                        "source.fixAll": "explicit",
+                        "source.formatDocument": "always"
+                    }
+                },
+                "files.watcherExclude": {
+                    "**/.git/objects/**": true,
+                    "**/.git/subtree-cache/**": true,
+                    "**/.hg/store/**": true,
+                    "**/.pytest_cache/**": true,
+                    "**/.ruff_cache/**": true,
+                    "**/__pycache__/**": true,
+                    "./data/**": true,
+                }
+            }
+        }
+    },
+    "remoteUser": "root",
+    "containerUser": "root",
+    "postCreateCommand": "mkdir .vscode -p && cp /example/.devcontainer/container-launch.json .vscode/launch.json && pre-commit install -t pre-commit && pre-commit install-hooks",
+    "features": {
+        "ghcr.io/jsburckhardt/devcontainer-features/ruff:1": {},
+        "ghcr.io/jsburckhardt/devcontainer-features/uv:1": {}
+    }
+    // Features to add to the dev container. More info: https://containers.dev/features.
+    // "features": {},
+    // Use 'forwardPorts' to make a list of ports inside the container available locally.
+    // "forwardPorts": [],
+    // Use 'postCreateCommand' to run commands after the container is created.
+    // "postCreateCommand": "pip3 install --user -r requirements.txt",
+    // Configure tool-specific properties.
+    // "customizations": {},
+    // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+    // "remoteUser": "root"
+}

.devcontainer/docker-compose.yaml

@@ -0,0 +1,15 @@
+name: example-dev
+services:
+  example:
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+    ports:
+      - "8002:8002"
+    environment:
+      - MODULE_NAME=example
+      - BASE_PATH=/data
+      - PYTHONDONTWRITEBYTECODE=1
+    volumes:
+      - ..:/example
+      - ../data:/data

.github/dependabot.yml

@@ -0,0 +1,12 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for more information:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+# https://containers.dev/guide/dependabot
+
+version: 2
+updates:
+ - package-ecosystem: "devcontainers"
+   directory: "/"
+   schedule:
+     interval: weekly

.github/workflows/deploy.yaml

@@ -0,0 +1,20 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy App Engine
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup new version on Server
+        uses: appleboy/ssh-action@master
+        with:
+          host: ${{ secrets.PRODUCTION_SERVER_HOST }}
+          username: ${{ secrets.PRODUCTION_SERVER_USERNAME }}
+          key: ${{ secrets.PRODUCTION_SERVER_SSH_KEY }}
+          script: |
+            /home/exior/code/deploy_scripts/build_deploy_app_engine

.github/workflows/linter.yaml

@@ -0,0 +1,16 @@
+name: Linter
+
+on: [pull_request]
+
+jobs:
+  lint-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Lint
+        uses: astral-sh/ruff-action@v2
+      - name: Check Format
+        uses: astral-sh/ruff-action@v2
+        with:
+          args: "format --check"

.github/workflows/tests.yaml

@@ -0,0 +1,20 @@
+name: Tester
+
+on: [pull_request]
+
+jobs:
+    test:
+        runs-on: ubuntu-latest
+
+        steps:
+        - uses: actions/checkout@v4
+        - name: Install uv
+          uses: astral-sh/setup-uv@v4
+        - name: "Set up Python"
+          uses: actions/setup-python@v5
+          with:
+            python-version-file: ".python-version"
+        - name: Install the project
+          run: uv sync --all-extras --dev
+        - name: Run tests
+          run: uv run pytest --cov