FastAPI Starter Base.

Author: EdyVision

.gitignore

@@ -0,0 +1,118 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+**/.DS_Store
+**/__pycache__
+bin
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.envrc
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Editor stuff
+.idea
+
+backend/bin

Dockerfile.web

@@ -0,0 +1,38 @@
+FROM python:3.9
+
+RUN pip install fastapi uvicorn
+
+# Install Environment Dependencies (Image Base)
+RUN pip install fastapi uvicorn poetry wheel virtualenv
+
+EXPOSE 8000
+EXPOSE 8001
+
+# set working directory
+WORKDIR /usr/src/app
+
+ARG db_url="mongodb://db:27017"
+ARG db_name="fastapistarter"
+
+# set environment variables
+ENV PORT 8000
+ENV HOST "0.0.0.0"
+ENV WEBHOOKS_PORT 8001
+ENV DB_URL=$db_url
+ENV DB_NAME=$db_name
+
+# Copy Required Project Assets
+COPY ./app/ /app/app
+COPY ./main.py /app
+COPY ./poetry.lock /app
+COPY ./pyproject.toml /app
+
+# Change directories
+WORKDIR /app
+
+# Install Project Dependencies
+RUN poetry config virtualenvs.create false \
+  && poetry install
+
+# Entry Point
+CMD ["python3", "main.py", "--host", "127.0.0.1", "--port", "8000"]

README.MD

@@ -0,0 +1,51 @@
+# FastAPI + GraphQL Starter 
+A python starter project using FastAPI and GraphQL. This project leverages docker for containerization and provides the scripts to deploy to Heroku. The starter is created for and used in the <a href="/">Building Python Apps with FastAPI</a> book by <a href="https://eidanrosado.com">Eidan J. Rosado</a>.
+
+### Running Services with Docker
+To avoid setting up MongoDB and other such services locally, the team uses Docker. You'll need to install Docker to proceed pulling the image from the team's hub. Contact one of the team admins for access to the hub. To start peripheral services simply execute the following:
+
+```bash
+docker-compose up
+```
+
+To refresh the image on your local (for server devs), run the following: 
+
+```bash
+docker build -t fastapistarter -f Dockerfile.web .
+```
+
+You can run the one off image and container with the following:
+
+```bash
+docker run -d --name fastapistarter -p 8000:8000 -p 8001:8001 fastapistarter
+```
+
+## Using Heroku
+If you are pushing to your personal stack on Heroku, you'll need to run the dockerization steps above to build the base image and then follow up with the Heroku containerization steps below.
+
+'''bash
+heroku container:push --recursive
+heroku container:release web
+'''
+
+<em>Note: You must do a heroku login or use API tokens to push to the container registry</em>
+
+### Running API Locally
+You'll need the following environment variables configured or in a .env file to run the server successfully:
+
+```bash
+# FastAPI Setup
+export HOST="127.0.0.1"
+export PORT=8000
+export WEBHOOKS_PORT=8001
+
+# fastapistarter DB Setup
+export DB_URL='mongodb://localhost:27017'
+export DB_NAME='fastapistarter'
+```
+
+The main entry point is main.py, so you can start that file from command line or use whatever execution method is available from your IDE. To install the IDE to interact with GraphQL, look in the SETUP.md for GraphQL Playground installation instructions then simply open the GraphQL Playground to interact with the local server and insert the base url <em>http://127.0.0.1:8000/api</em>. For more detailed instructions, check the wiki.
+
+## Dev Notes
+### Viewing Changes
+Changes under /app may be picked up by the auto-refresh (no need to restart server). To understand how to use the playground to run queries, please reference the following: <a href="https://graphql.org/learn/queries/">GraphQL Queries Reference</a>

app/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.1.0'

app/config/__init__.py

@@ -0,0 +1,22 @@
+from pydantic import BaseSettings
+
+class CommonSettings(BaseSettings):
+    APP_NAME: str = "FastAPI GraphQL Starter"
+    DEBUG_MODE: bool = False
+
+class ServerSettings(BaseSettings):
+    HOST: str = "127.0.0.1"
+    PORT: int = 8000
+    WEBHOOKS_PORT: int = 8001
+
+
+class DatabaseSettings(BaseSettings):
+    DB_URL: str = ''
+    DB_NAME: str = ''
+
+class Settings(CommonSettings, ServerSettings, DatabaseSettings):
+    class Config:
+        env_file = '.env'
+        env_file_encoding = 'utf-8'
+
+settings = Settings()

app/graphql/__init__.py

@@ -0,0 +1,13 @@
+import strawberry
+from strawberry.asgi import GraphQL
+
+from app.resolvers.hello.resolve_hello import *
+
+
+@strawberry.type
+class Query:
+    hello_world = strawberry.field(resolve_hello_world)
+
+
+schema = strawberry.Schema(query=Query())
+graphql_app = GraphQL(schema, debug=True, )

app/models/hello/hello_response_models.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+import strawberry
+from dataclasses import dataclass
+from dataclasses_json import dataclass_json, LetterCase
+
+
+@dataclass_json(letter_case=LetterCase.CAMEL)
+@dataclass
+@strawberry.type
+class HelloResponse:
+    message: str = None
+    timestamp: str = None

app/resolvers/hello/resolve_hello.py

@@ -0,0 +1,8 @@
+import datetime
+
+from app.models.hello.hello_response_models \
+    import HelloResponse
+
+
+async def resolve_hello_world() -> HelloResponse:
+    return HelloResponse("Hello World!", datetime.datetime.now())

docker-compose.yaml

@@ -0,0 +1,20 @@
+version: '3.8'
+
+services:
+    mongo:
+        image: mongo
+        restart: always
+        ports:
+            - 27017:27017
+    fastapistarter:
+        image: fastapistarter
+        restart: always
+        ports:
+            - 8000:8000
+            - 8001:8001
+        links:
+            - mongo
+        environment:
+            - PORT=8000
+            - DB_URL=mongodb://mongo:27017
+            - DB_NAME=fastapistarter

main.py

@@ -0,0 +1,32 @@
+import datetime
+import uvicorn
+from fastapi import FastAPI
+
+from app.config import settings
+from app.graphql import graphql_app
+
+app = FastAPI()
+app.mount('/graph', graphql_app)
+
+
+@app.on_event('startup')
+async def startup():
+    public_paths = {'/', '/graph'},
+
+
+@app.get("/")
+async def root():
+    return {"message": {
+        "app_name": settings.APP_NAME,
+        "system_time": datetime.datetime.now()
+    }}
+
+
+if __name__ == "__main__":
+    uvicorn.run(
+        "main:app",
+        host=settings.HOST,
+        reload=True,
+        port=settings.PORT,
+        debug=False
+    )