Initial project setup

Author: renceInbox

.dockerignore

@@ -0,0 +1,13 @@
+venv/
+.flake8
+.mypy_cache
+.envs
+
+.idea
+*.lock
+.DS_Store
+**/__pycache__/
+.envs/
+celery-beat-schedule
+celerybeat-schedule
+*.pid

.env.sample

@@ -0,0 +1,6 @@
+KEYCLOAK_SERVER_URL=https://sample.com
+KEYCLOAK_CLIENT_ID=sample
+KEYCLOAK_REALM_NAME=sample
+KEYCLOAK_CLIENT_SECRET=sample
+KEYCLOAK_ADMIN_CLIENT_SECRET=sample
+KEYCLOAK_CALLBACK_URI=http://sample.com/callback

.gitignore

@@ -0,0 +1,60 @@
+*.pyc
+*.pyo
+*.pyd
+
+# C extensions
+*.so
+
+# Packages
+__pycache__
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+.venv/
+venv/
+.env
+
+# Python debug
+pdb/
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery
+celerybeat-schedule*
+celerybeat.pid
+
+# Flask stuff
+instance/
+.webassets-cache
+
+# Intellij IDEA specifics
+.idea/
+.fleet/
+
+# Qt related
+*.log
+*.log.*
+*.swo
+*.swp
+.DS_Store
+.AppleDouble
+.LSOverride
++47

.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+exclude: 'docs|node_modules|migrations|.git|.tox|.mypy_cache|frontend'
+default_stages: [commit]
+fail_fast: true
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: requirements-txt-fixer
+      - id: check-merge-conflict
+  - repo: https://github.com/myint/autoflake
+    rev: v1.4
+    hooks:
+      - id: autoflake
+        args: ['--in-place', '--remove-all-unused-imports', '--remove-unused-variables', '--ignore-init-module-imports']
+  - repo: https://github.com/psf/black
+    rev: 23.11.0
+    hooks:
+      - id: black
+  - repo: https://github.com/PyCQA/bandit
+    rev: '1.7.5'
+    hooks:
+      - id: bandit

app/__init__.py

@@ -0,0 +1,24 @@
+from fastapi import APIRouter, Depends
+from fastapi_keycloak import OIDCUser
+
+from app.keycloak import idp
+
+router = APIRouter()
+
+
+@router.get("/")
+def home():
+    """Public home page."""
+    return {"message": "Hello World! This is a public endpoint"}
+
+
+@router.get("/me/")
+def my_user(user: OIDCUser = Depends(idp.get_current_user())):
+    """Shows the logged-in user's info. No specified role required."""
+    return user
+
+
+@router.get("/admin/")
+def my_admin(user: OIDCUser = Depends(idp.get_current_user(required_roles=["admin"]))):
+    """Endpoint specific for admins."""
+    return {"message": "Hello admin! This is an admin-only endpoint"}

app/api/endpoints.py

@@ -0,0 +1,6 @@
+from fastapi import APIRouter
+
+from app import api
+
+api_router_v1 = APIRouter()
+api_router_v1.include_router(api.router)

app/api/routers.py

@@ -0,0 +1,25 @@
+from pydantic import BaseModel
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class KeycloakSettings(BaseModel):
+    server_url: str
+    client_id: str
+    client_secret: str
+    realm_name: str
+    admin_client_secret: str
+    callback_uri: str
+
+
+class Settings(BaseSettings):
+    model_config = SettingsConfigDict(env_file=".env", extra='ignore')
+
+    keycloak_server_url: str
+    keycloak_client_id: str
+    keycloak_client_secret: str
+    keycloak_realm_name: str
+    keycloak_admin_client_secret: str
+    keycloak_callback_uri: str
+
+
+settings = Settings()

app/config/base.py

@@ -0,0 +1,12 @@
+from fastapi_keycloak import FastAPIKeycloak
+
+from app.config.base import settings
+
+idp = FastAPIKeycloak(
+    server_url=settings.keycloak_server_url,
+    client_id=settings.keycloak_client_id,
+    client_secret=settings.keycloak_client_secret,
+    admin_client_secret=settings.keycloak_admin_client_secret,
+    realm=settings.keycloak_realm_name,
+    callback_uri=settings.keycloak_callback_uri
+)

app/config/keycloak.py

@@ -0,0 +1,10 @@
+from fastapi import FastAPI
+
+from app.api.routers import api_router_v1
+
+app = FastAPI()
+app.swagger_ui_init_oauth = {
+    "usePkceWithAuthorizationCodeGrant": True,
+}
+
+app.include_router(api_router_v1)