🐳 updated compose file and clearer structure 🎨

Author: jmeisele

docker-compose.yml

@@ -8,5 +8,6 @@ services:
             dockerfile: Dockerfile
         ports: 
             - "3000:3000"
+        command: ["pipenv", "run", "uvicorn", "fastapi_scaffolding.main:app", "--host=0.0.0.0", "--port=3000", "--workers=10"]
         # volumes: 
         #     - ./app1:/app

docs/sample_payload.json

@@ -0,0 +1,10 @@
+{
+  "median_income_in_block": 8.3252,
+  "median_house_age_in_block": 41,
+  "average_rooms": 6,
+  "average_bedrooms": 1,
+  "population_per_block": 322,
+  "average_house_occupancy": 2.55,
+  "block_latitude": 37.88,
+  "block_longitude": -122.23
+}

fastapi_scaffolding/api/routes/heartbeat.py

@@ -1,12 +1,12 @@
 
 from fastapi import APIRouter
 
-from fastapi_scaffolding.models.heartbeat import HearbeatResult
+from fastapi_scaffolding.data_models.heartbeat import HearbeatResult
 
 router = APIRouter()
 
 
 @router.get("/heartbeat", response_model=HearbeatResult, name="heartbeat")
 def get_hearbeat() -> HearbeatResult:
     heartbeat = HearbeatResult(is_alive=True)
-    return heartbeat
+    return heartbeat

fastapi_scaffolding/api/routes/prediction.py

@@ -2,9 +2,15 @@
 from starlette.requests import Request
 
 from fastapi_scaffolding.core import security
-from fastapi_scaffolding.models.payload import HousePredictionPayload # Incoming payload data model
-from fastapi_scaffolding.models.prediction import HousePredictionResult # Outbound prediction result data model
-from fastapi_scaffolding.services.models import HousePriceModel # ML Model itself
+
+# Incoming payload data model
+from fastapi_scaffolding.data_models.payload import HousePredictionPayload
+
+# Outbound prediction result data model
+from fastapi_scaffolding.data_models.prediction import HousePredictionResult
+
+# ML Model object itself
+from fastapi_scaffolding.services.models import HousePriceModel
 
 router = APIRouter()
 

fastapi_scaffolding/models/__init__.py …tapi_scaffolding/data_models/__init__.pyfastapi_scaffolding/models/__init__.py renamed to fastapi_scaffolding/data_models/__init__.py fastapi_scaffolding/models/__init__.py renamed to fastapi_scaffolding/data_models/__init__.py

@@ -5,4 +5,4 @@
 
 class HousePredictionResult(BaseModel):
     median_house_value: int
-    currency: str = "USD"
+    currency: str = "USD"

fastapi_scaffolding/models/heartbeat.py …api_scaffolding/data_models/heartbeat.pyfastapi_scaffolding/models/heartbeat.py renamed to fastapi_scaffolding/data_models/heartbeat.py fastapi_scaffolding/models/heartbeat.py renamed to fastapi_scaffolding/data_models/heartbeat.py

@@ -2,9 +2,9 @@
 
 from fastapi_scaffolding.api.routes.router import api_router
 from fastapi_scaffolding.core.config import (API_PREFIX, APP_NAME, APP_VERSION,
-                                          IS_DEBUG)
+                                             IS_DEBUG)
 from fastapi_scaffolding.core.event_handlers import (start_app_handler,
-                                                  stop_app_handler)
+                                                     stop_app_handler)
 
 
 def get_app() -> FastAPI:
@@ -18,4 +18,4 @@ def get_app() -> FastAPI:
     return fast_app
 
 
-app = get_app()
+app = get_app()

fastapi_scaffolding/models/payload.py …stapi_scaffolding/data_models/payload.pyfastapi_scaffolding/models/payload.py renamed to fastapi_scaffolding/data_models/payload.py fastapi_scaffolding/models/payload.py renamed to fastapi_scaffolding/data_models/payload.py

@@ -5,9 +5,9 @@
 from loguru import logger
 
 from fastapi_scaffolding.core.messages import NO_VALID_PAYLOAD
-from fastapi_scaffolding.models.payload import (HousePredictionPayload,
-                                             payload_to_list)
-from fastapi_scaffolding.models.prediction import HousePredictionResult
+from fastapi_scaffolding.data_models.payload import (HousePredictionPayload,
+                                                     payload_to_list)
+from fastapi_scaffolding.data_models.prediction import HousePredictionResult
 
 
 class HousePriceModel(object):