__main__ file added for entrypoint for the api

Author: ilkersigirci

Makefile

@@ -174,8 +174,12 @@ profile-builtin: ## Profile the file with cProfile and shows the report in the t
 docker-build: ## Build docker image
 	docker build --tag ${DOCKER_IMAGE} --file docker/Dockerfile --target ${DOCKER_TARGET} .
 
-run-local-app: ## Run the app in the local mode
-	uv run --module fastapi run app/main.py --reload --port 8000
+run-dev: ## Run the app in the dev mode
+	# uv run --module uvicorn app.main:app --port 8000
+	uv run --module app.__main__
+
+# run-prod: ## Run the app in the prod mode
+# 	uv run --module fastapi run app/main.py --port 8000
 
 run-ui:
 	uv run --module uvicorn ui.main:app --host 0.0.0.0 --port 5002

app/__main__.py

@@ -0,0 +1,41 @@
+import os
+import shutil
+from pathlib import Path
+
+import uvicorn
+
+from app.core.config import settings
+
+
+def set_multiproc_dir() -> None:
+    """
+    Sets mutiproc_dir env variable.
+
+    This function cleans up the multiprocess directory
+    and recreates it. This actions are required by prometheus-client
+    to share metrics between processes.
+    """
+    shutil.rmtree(settings.PROMETHEUS_DIR, ignore_errors=True)
+    Path(settings.PROMETHEUS_DIR).mkdir(parents=True)
+    os.environ["PROMETHEUS_MULTIPROC_DIR"] = str(
+        settings.PROMETHEUS_DIR.expanduser().absolute(),
+    )
+
+
+def main() -> None:
+    """Entrypoint of the application."""
+    set_multiproc_dir()
+
+    uvicorn.run(
+        "app.api.application:get_app",
+        workers=settings.WORKERS,
+        host=settings.HOST,
+        port=settings.PORT,
+        reload=settings.RELOAD,
+        log_level=settings.LOG_LEVEL.value.lower(),
+        factory=True,
+    )
+
+
+if __name__ == "__main__":
+    main()

app/api/application.py

@@ -0,0 +1,43 @@
+from pathlib import Path
+
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+from fastapi.responses import JSONResponse
+from fastapi.staticfiles import StaticFiles
+
+from app.api.lifespan import lifespan_setup
+from app.api.v1.api import api_router
+from app.core.config import settings
+from app.core.log import configure_logging
+
+APP_ROOT = Path(__file__).parent.parent
+
+
+def get_app() -> FastAPI:
+    """Get FastAPI application."""
+    configure_logging()
+
+    app = FastAPI(
+        title=settings.PROJECT_NAME,
+        version="0.0.1",
+        docs_url=None,
+        redoc_url=None,
+        openapi_url=f"{settings.API_V1_STR}/openapi.json",
+        lifespan=lifespan_setup,
+        default_response_class=JSONResponse,
+    )
+
+    app.add_middleware(
+        CORSMiddleware,
+        allow_origins=settings.CORS_ORIGINS,
+        allow_credentials=True,
+        allow_methods=["*"],
+        allow_headers=["*"],
+    )
+
+    app.include_router(api_router, prefix=settings.API_V1_STR)
+
+    # Adds static directory. This directory is used to access swagger files.
+    app.mount("/static", StaticFiles(directory=APP_ROOT / "static"), name="static")
+
+    return app

app/lifespan.py app/api/lifespan.pyapp/lifespan.py renamed to app/api/lifespan.py

@@ -1,11 +1,18 @@
 from fastapi import APIRouter, Depends
 
-from app.api.v1.endpoints import auth, docs, items, users
+from app.api.v1.endpoints import auth, docs, health, items, users
 from app.dependencies.auth import get_current_user
 
 api_router = APIRouter()
+
 api_router.include_router(docs.router)
-api_router.include_router(auth.router, prefix="/auth", tags=["auth"])
+api_router.include_router(health.router)
+
+api_router.include_router(
+    auth.router,
+    prefix="/auth",
+    tags=["auth"],
+)
 api_router.include_router(
     users.router,
     prefix="/users",

app/api/v1/api.py

@@ -0,0 +1,11 @@
+from fastapi import APIRouter
+
+router = APIRouter()
+
+
+@router.get("/health")
+def health_check() -> None:
+    """Checks the health of a project.
+
+    It returns 200 if the project is healthy.
+    """

app/api/v1/endpoints/health.py

@@ -1,8 +1,7 @@
-from typing import Annotated, Optional
+from typing import Annotated
 
 from fastapi import APIRouter, Depends, Query
 
-# from pydantic import Field
 from app.dependencies.repositories import get_item_service
 from app.models.item import Item, ItemCreate, ItemUpdate
 from app.services.item_service import ItemService
@@ -13,13 +12,16 @@
 @router.get("/")
 async def get_items(  # noqa: PLR0913
     item_service: Annotated[ItemService, Depends(get_item_service)],
-    skip: int = Query(0, ge=0, description="Number of items to skip"),
-    # skip: int = Field(0, ge=0, description="Number of items to skip"), # FIXME: Not working
-    limit: int = Query(100, ge=1, le=100, description="Number of items to return"),
-    name: Optional[str] = Query(None, description="Filter items by name"),
-    description: Optional[str] = Query(None, description="Filter items by description"),
-    sort_by: Optional[str] = Query(None, description="Field to sort by"),
-    order: Optional[str] = Query("asc", description="Sort order (asc or desc)"),
+    skip: Annotated[int, Query(ge=0, description="Number of items to skip")] = 0,
+    limit: Annotated[
+        int, Query(ge=1, le=100, description="Number of items to return")
+    ] = 100,
+    name: Annotated[str | None, Query(description="Filter items by name")] = None,
+    description: Annotated[
+        str | None, Query(description="Filter items by description")
+    ] = None,
+    sort_by: Annotated[str | None, Query(description="Field to sort by")] = None,
+    order: Annotated[str | None, Query(description="Sort order (asc or desc)")] = "asc",
 ) -> list[Item]:
     return item_service.get_items(
         skip=skip,
@@ -29,7 +31,6 @@ async def get_items(  # noqa: PLR0913
         sort_by=sort_by,
         order=order,
     )
-    # return {"message": "Get all items"}
 
 
 @router.get("/{item_id}")

app/api/v1/endpoints/items.py

@@ -1,14 +1,13 @@
 from enum import StrEnum
+from pathlib import Path
+from tempfile import gettempdir
 from typing import Annotated
 
-from pydantic import (
-    AfterValidator,
-    AnyHttpUrl,
-    PlainValidator,
-    TypeAdapter,
-)
+from pydantic import AfterValidator, AnyHttpUrl, Field, PlainValidator, TypeAdapter
 from pydantic_settings import BaseSettings
 
+TEMP_DIR = Path(gettempdir())
+
 AnyHttpUrlAdapter = TypeAdapter(AnyHttpUrl)
 
 CustomHttpUrlStr = Annotated[
@@ -45,6 +44,10 @@ class Settings(BaseSettings):
     TELEMETRY_ENABLED: bool = False
     TELEMETRY_LOGGING_ENABLED: bool = False
     WORKERS: int = 1
+    PROMETHEUS_DIR: Path = Field(
+        default=TEMP_DIR / "prom",
+        description="This variable is used to define multiproc_dir.It's required for [uvi|guni]corn projects.",
+    )
 
     class Config:
         case_sensitive = True