Separate metadata concerns out of main.py.

Author: UPstartDeveloper

app/main.py

@@ -1,27 +1,17 @@
 from fastapi import FastAPI, File, UploadFile
 from fire_classifier.predictor import ImagePredictor
+from fire_classifier.util.api import API
 
-# A: define description for the API endpoints (shown on UI)
-endpoint_metadata = [
-    {
-        "name": "classify-image",
-        "description": "Predicts the possibility that a RBG image contains fire.",
-    },
-]
-# B: init API
-app = FastAPI(
-    title="DeepFire",
-    description="A REST API for detecting the presence of fire in an image.",
-    version="0.0.2",
-    openapi_tags=endpoint_metadata,
-)
+# A: init API
+app = FastAPI(title=API["title"], description=API["description"],
+              version=API["version"], openapi_tags=API["endpoints"])
 
-# C: init ML inference object
-predictor_config_path = "./app/config.yaml"
+# B: init ML inference object, and the routes
+predictor_config_path = API["config_path"]
 predictor = ImagePredictor.init_from_config_path(predictor_config_path)
 
 
-@app.post("/classify-image/", tags=["classify-image"])
+@app.post("/classify-image/", tags=["Detect Fire"])
 def create_upload_file(file: UploadFile = File(...)):
     """Predicts the possibility that a RBG image contains fire."""
     return predictor.predict_from_file(file.file)

fire_classifier/util/__init__.py

@@ -0,0 +1,29 @@
+import os
+from pathlib import Path
+
+# General info about the API
+API_TITLE = "DeepFire"
+API_DESCRIPTION = "A REST API for detecting the presence of fire in an image."
+API_VERSION = "0.0.2"
+
+# Info about what data users can request.
+# These are intended shown on the UI, related only to a specific endpoint.
+API_ENDPOINTS = (
+    {
+        "name": "Detect Fire",
+        "description": "Predicts the possibility that a color image contains fire.",
+    },
+)
+
+# Tells the app how to find the config.yaml (for running ML inference)
+BASE_DIR = Path(__file__).resolve().parent.parent.parent
+CONFIG_PATH = os.path.join(BASE_DIR, 'app', 'config.yaml')
+
+# Wraps all the API metadata as one dictionary
+API = {
+    "title": API_TITLE,
+    "description": API_DESCRIPTION,
+    "version": API_VERSION,
+    "endpoints": API_ENDPOINTS,
+    "config_path": CONFIG_PATH,
+}