Establishing Dev Branch

Author: blevinscm

README.md

@@ -25,33 +25,54 @@ This uis how I set up a new FastAPI project.  I hope this is helpful.
   |[virtualenv](https://virtualenv.pypa.io/en/stable/installation.html) | Again I am not trying to get fancy.  ```py -m pip install virtualenv```|
   |[FastAPI](https://github.com/tiangolo/fastapi) |  I usally install all related packages in my venv. ```pip install fastapi[all]```  |
   |[Docker](https://www.docker.com/products/docker-desktop) | (Optional) I use it to startup DBs instead of installing directly. Will make your life easier. There are also images for bundled FastAPI environmets on Docker Hub.
-  |[ODMantic](https://art049.github.io/odmantic/) | ORM for MongoDB with great model and document support. |
+  |[ODMantic](https://art049.github.io/odmantic/) | (Optional) ORM for MongoDB with great model and document support. |
   |[TortoiseORM](https://tortoise-orm.readthedocs.io/en/latest/) | (Optional) ASYNC ORM that works well with FastAPI and Postgres/MySQL
 
 
-## Setup virtual environment (Windows)
+## Get Started
 
-https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/
+1. Install Python if not already installed
 
-1. Make sure venv is installed globally
-    ```bash
+2. Clone this repository: 
+   ```git
+    git clone https://github.com/blevinscm/fastapi-scaffold-base.git
+    ```
+
+3. Install virtualenv
+    ```zsh
     py -m pip install --user virtualenv
     ```
-2. cd into workspace
-3. Create virtual environment
+4. CD into project directory
+    ```zsh
+        cd dir 
+    ```
+5. Create virtual environment
     ```bash
     py -m venv env
     ```
-4. Activate virtual environment
+6. Activate virtual environment
     ```bash
-    .\env\Scripts\activate
+    source .\env\bin\activate
     ```
-5. Install pip dependencies
+7. Install pip dependencies (This will install all FastAPI Modules.  If you do not want [all] plese adjust the req file.)
     ```bash
     pip install -r requirements.txt
     ```
-6. Now you can run the ```__main__.py``` script from a virtual context ```python lib```
-7. To get out of venv
+8. (Optional) Pull latest Mongo image and create mongo container for dev purposes
+    ```docker
+    docker pull mongo:latest
+    docker run --rm --net=host mongo
+    ```
+9. Set execute permissions on either win-start-FastApi.ps1 or nix-start-FastAPI
+
+10. Run the start-FastAPI for your system 
+
+11. Go to https://localhost:8000/docs to see your FastAPI documentation and explore the sample docs. 
+
+
+12. Close your FastAPI terminal and your Mongo Terminal.
+
+11. To get out of venv
     ```bash
     deactivate
     ```

app/data/data.py

@@ -0,0 +1,40 @@
+from typing import List
+
+from fastapi import FastAPI, HTTPException
+
+from odmantic import AIOEngine, Model, ObjectId
+
+
+class Hug(Model):
+    kind: str
+    hug_size: float
+    hugger: str
+
+
+engine = AIOEngine()
+
+
+@app.put("/hugs/", response_model=Hug)
+async def new_hug(hug: Hug):
+    await engine.save(hug)
+    return hug
+
+
+@app.get("/hugs/", response_model=List[Hug])
+async def get_hugs():
+    trees = await engine.find(Hug)
+    return trees
+
+
+@app.get("/hugs/count", response_model=int)
+async def count_hugs():
+    count = await engine.count(Hug)
+    return count
+
+
+@app.get("/hugs/{id}", response_model=Hug)
+async def get_tree_by_id(id: ObjectId):
+    hug = await engine.find_one(Hug, Hug.id == id)
+    if hug is None:
+        raise HTTPException(404)
+    return hug

app/data/models.py

@@ -0,0 +1,13 @@
+from fastapi import Depends, FastAPI, Header, HTTPException
+
+from .routers import hugs
+
+app = FastAPI()
+
+
+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/data/models/__init__.py

@@ -0,0 +1,29 @@
+from fastapi import APIRouter
+from data import models
+
+router = APIRouter()
+
+
+@router.get("/hugs/", tags=["Friendly_Hugs"])
+async def read_hugs():
+    """
+    Returns all huggers available
+    """
+    return [{"hugs": "Pooh"}, {"username": "Bear"}]
+
+
+@router.get("/hugs/me", tags=["Friendly_Hugs"])
+async def read_huggee_me():
+    """
+    Set to return user context. In this case the hugee.
+    """
+    return {"username": "Huggable Developer"}
+
+
+@router.get("/hugs/{type}", tags=["Friendly_Hugs"])
+async def read_hug_type(hug_type: str):
+    """
+    Allows user to enter the type of hug they want.
+    Replace with any single non-enum type.
+    """
+    return {"username": hug_type}

app/data/models/models.py

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

app/main.py

@@ -0,0 +1,2 @@
+FastAPI[all]
+ODMantic