Merge pull request #2 from blevinscm/dev

Dev merge back into master

Author: blevinscm

.vscode/settings.json

@@ -1,3 +1,3 @@
 {
-    "python.pythonPath": "/home/blevinscm/src/fastapi-scaffold-base/env/bin/python3.8"
+    "python.pythonPath": "/home/blevinscm/src/fastapi-scaffold-base/env/bin/python3.9"
 }

html/index.html renamed to app/config/config.yml

@@ -1,8 +1,16 @@
 import typing
-from odmantic import AIOEngine, Model, ObjectId
+from odmantic import Model
+from pydantic import BaseModel
 
 
+#MongodDB - uncomment to use odmantic and MongoDB
 class Hug(Model):
     kind: str
     hug_size: float
-    hugger: str
+    hugger: str
+
+# POSTGRES - uncomment to use Pydantic and PG
+# class Hug(BaseModel):
+#     hug: str
+#     hug_size: float
+#     hugger: str

app/data/models.py

@@ -1,13 +1,44 @@
-from fastapi import Depends, FastAPI, Header, HTTPException
-
+from fastapi import Request, FastAPI, Header, HTTPException
+from fastapi.templating import Jinja2Templates
+from fastapi.responses import HTMLResponse
+from fastapi.staticfiles import StaticFiles  
 from .routers import hugs
 
-app = FastAPI()
+
+templates = Jinja2Templates(directory="templates")
+
+tags_metadata = [
+    {
+        "name": "hugs",
+        "description": "The **hug** is _wonderful_.",
+        "externalDocs": {
+            "description": "Hugs external docs. Use to provide a link.",
+            "url": "https://en.wikipedia.org/wiki/Hug",
+        },
+    },
+  
+]
+app = FastAPI(
+    openapi_tags=tags_metadata,
+    title="The super duper Hugs API",
+    description="This is an example for the base project Generator",
+    version="0.0.0.0.0.0.1",
+
+)
 
 
 async def get_token_header(x_token: str = Header(...)):
     if x_token != "fake-super-secret-token":
         raise HTTPException(status_code=400, detail="X-Token header invalid")
 
 
-app.include_router(hugs.router)
+app.include_router(hugs.router)
+app.mount("/static", StaticFiles(directory="static"), name="static")
+
+@app.get("/")
+async def serve_home(request: Request):
+    return templates.TemplateResponse("index.html", {"request": request})
+
+@app.get("/my")
+async def serve_my(request: Request):
+    return templates.TemplateResponse("my.html", {"request": request})

app/main.py

@@ -1,7 +1,7 @@
 from fastapi import APIRouter, HTTPException
 from app.data import models
 from typing import List
-from odmantic import AIOEngine, Model, ObjectId
+from odmantic import AIOEngine, ObjectId
 
 router = APIRouter()
 
@@ -10,24 +10,42 @@
 
 @router.put("/hugs/", response_model=Hug, tags=["hugs"])
 async def new_hug(hug: Hug):
+    '''
+    Add a hug to the Database.
+    Delete the objectID from the example if using 
+    swaggerUI
+    Use to add or edit an item in the DB. Do not use Post
+    when using MongoDB.
+    '''
     await engine.save(hug)
     return hug
 
 
 @router.get("/hugs/", response_model=List[Hug], tags=["hugs"])
 async def get_hugs():
-    trees = await engine.find(Hug)
-    return trees
+    '''
+    Get all the hugs from the database.
+    Used to get a list of the items in the database.
+    '''
+    hugs = await engine.find(Hug)
+    return hugs
 
 
 @router.get("/hugs/count", response_model=int, tags=["hugs"])
 async def count_hugs():
+    '''
+    Count all the hugs in the database.
+    Useful for determining pagination, optimizations.
+    '''
     count = await engine.count(Hug)
     return count
 
 
 @router.get("/hugs/{id}", response_model=Hug, tags=["hugs"])
-async def get_tree_by_id(id: ObjectId):
+async def get_hug_by_id(id: ObjectId):
+    '''
+    Find a specific hug by ID.
+    '''
     hug = await engine.find_one(Hug, Hug.id == id)
     if hug is None:
         raise HTTPException(404)

app/routers/hugs.py

@@ -1,3 +1,3 @@
 #!/bin/bash
 
-uvicorn app.main:app --reload
+uvicorn app.main:app --reload

html/layout.html

@@ -7,3 +7,26 @@ pydantic==1.7.2
 pymongo==3.11.0
 starlette==0.13.6
 uvicorn==0.12.2
+click==7.1.2
+fastapi==0.61.2
+h11==0.11.0
+motor==2.3.0
+multipart==0.2.2
+odmantic==0.3.0
+pydantic==1.7.2
+pymongo==3.11.0
+starlette==0.13.6
+uvicorn==0.12.2
+aiofiles==0.6.0
+click==7.1.2
+fastapi==0.61.2
+h11==0.11.0
+Jinja2==2.11.2
+MarkupSafe==1.1.1
+motor==2.3.0
+multipart==0.2.2
+odmantic==0.3.0
+pydantic==1.7.2
+pymongo==3.11.0
+starlette==0.13.6
+uvicorn==0.12.2