feat: add redis and rate limiter; docs: update readme; ops: add black step

Author: nickatnight

.env_example

@@ -14,3 +14,5 @@ MONGO_INITDB_DATABASE=fastapibackendbase
 
 NGINX_HOST=localhost
 UPSTREAMS=/:backend:8000
+
+REDIS_HOST=redis://redis:6379

.github/workflows/main.yml

@@ -15,3 +15,19 @@ jobs:
       - name: Start linter
         run: |
           docker run --rm -w="/code/backend" -v $(pwd):/code alpine/flake8:3.9.2 .
+
+  black:
+    runs-on: ubuntu-20.04
+    name: Black code formatting
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: '3.9'
+      - name: run black
+        working-directory: ./backend
+        run: |
+          pip install black==21.5b1
+          black --check .

README.md

@@ -1,11 +1,33 @@
+<p align="center">
+    <a href="https://github.com/nickatnight/fastapi-backend-base/actions">
+        <img alt="GitHub Actions status" src="https://github.com/nickatnight/fastapi-backend-base/actions/workflows/main.yml/badge.svg">
+    </a>
+</p>
+
+
 # fastapi-backend-base
 
 Small base project to build and deploy a fastapi backend..batteries included.
 
-## Services
-* high performance [FastAPI](https://fastapi.tiangolo.com/) backend
-* asynchronous access to key/value [database](https://motor.readthedocs.io/en/stable/)
-* [nginx](https://www.nginx.com/blog/lets-encrypt-tls-nginx/) webserver/proxy with automatic ssl cert renewal
+## Features
+* **Docker Compose** integration and optimization for local development.
+* **Production ready** Python web server using Uvicorn
+* Python <a href="https://github.com/tiangolo/fastapi" class="external-link" target="_blank">**FastAPI**</a> backend:
+    * **Fast**: Very high performance, on par with **NodeJS** and **Go** (thanks to Starlette and Pydantic).
+    * **Intuitive**: Great editor support. <abbr title="also known as auto-complete, autocompletion, IntelliSense">Completion</abbr> everywhere. Less time debugging.
+    * **Easy**: Designed to be easy to use and learn. Less time reading docs.
+    * **Short**: Minimize code duplication. Multiple features from each parameter declaration.
+    * **Robust**: Get production-ready code. With automatic interactive documentation.
+    * **Standards-based**: Based on (and fully compatible with) the open standards for APIs: <a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank">OpenAPI</a> and <a href="http://json-schema.org/" class="external-link" target="_blank">JSON Schema</a>.
+    * <a href="https://fastapi.tiangolo.com/features/" class="external-link" target="_blank">**Many other features**</a> including automatic validation, serialization, interactive documentation, authentication with OAuth2 JWT tokens, etc.
+* **SQLAlchemy** models
+* **CORS** (Cross Origin Resource Sharing).
+* **NGINX** High Performance Load Balancer, Web Server, & Reverse Proxy
+* **Let's Encrypt** A free, automated, and open certificate authority (CA), provided by the Internet Security Research Group (ISRG)...with automatic cert renewal.
+* **MongoDB** General purpose, document-based, distributed database built for modern application developers.
+* **Motor** Coroutine-based API for non-blocking access to MongoDB
+* Request rate limiting for api routes.
+
 
 ## Usage
 1. `git clone https://github.com/nickatnight/fastapi-backend-base.git`

backend/requirements/base.txt

@@ -9,3 +9,4 @@ motor==2.4.0
 
 # utils
 PyYAML==5.4.1
+fastapi-limiter==0.1.4

backend/src/api/v1/health.py

@@ -1,10 +1,11 @@
-from fastapi import APIRouter
+from fastapi import APIRouter, Depends
+from fastapi_limiter.depends import RateLimiter
 
 
 router = APIRouter()
 
 
-@router.get("/ping", tags=["health"])
+@router.get("/ping", tags=["health"], dependencies=[Depends(RateLimiter(times=2, seconds=5))])
 async def pong():
     # some async operation could happen here
     # example: `data = await get_all_datas()`

backend/src/config.py

@@ -19,6 +19,8 @@ class Settings(BaseSettings):
     MONGODB_PASS: str = Field(..., env="MONGODB_PASS")
     MONGODB_DATABASE: str = Field(..., env="MONGODB_DATABASE")
 
+    REDIS_HOST: str = Field(..., env="REDIS_HOST")
+
     VERSION: str = Field(..., env="VERSION")
 
 

backend/src/db.py

@@ -1,8 +1,11 @@
+import aioredis
+from fastapi_limiter import FastAPILimiter
+
 from motor.motor_asyncio import AsyncIOMotorClient
 from src.config import settings
 
 
-MONGODB_URL = f"mongodb://{settings.MONGODB_USER}:{settings.MONGODB_PASS}@mongodb:27017/{settings.MONGODB_DATABASE}"  # noqa
+MONGODB_URL = f"mongodb://{settings.MONGODB_USER}:{settings.MONGODB_PASS}@{settings.MONGODB_HOST}:27017/{settings.MONGODB_DATABASE}"  # noqa
 
 
 class DataBase:
@@ -18,6 +21,9 @@ async def get_database() -> AsyncIOMotorClient:
 
 async def connect_to_mongo():
     db.client = AsyncIOMotorClient(MONGODB_URL, maxPoolSize=3, minPoolSize=0)
+    redis = await aioredis.create_redis_pool(settings.REDIS_HOST)
+
+    await FastAPILimiter.init(redis)
 
 
 async def close_mongo_connection():

docker-compose.yml

@@ -4,6 +4,7 @@ volumes:
   base-data:
   mongodb-data:
   proxy-data:
+  redis-data:
 
 services:
   mongodb:
@@ -28,9 +29,11 @@ services:
       args:
         env: ${ENV}
     ports:
-      - '8000:8000'
+      - "8000:8000"
     command: |
-        bash -c "while !</dev/tcp/mongodb/27017; do sleep 1; done; uvicorn src.main:app --reload --workers 1 --host 0.0.0.0 --port 8000 --log-config=logconfig.yml"
+        bash -c "
+        while !</dev/tcp/mongodb/27017; do sleep 1; done;
+        uvicorn src.main:app --reload --workers 1 --host 0.0.0.0 --port 8000 --log-config=logconfig.yml"
     depends_on:
       - mongodb
     environment:
@@ -42,11 +45,19 @@ services:
   proxy:
     restart: always
     ports:
-      - '0.0.0.0:80:80'
+      - "0.0.0.0:80:80"
     env_file:
       - .env
     build:
       context: ./proxy
       dockerfile: ./Dockerfile
     volumes:
         - proxy-data:/etc/letsencrypt
+
+  redis:
+    restart: always
+    image: redis:latest
+    ports:
+      - "6479:6379"
+    volumes:
+      - redis-data:/data

ops/docker-compose.staging.yml

@@ -7,8 +7,7 @@ RUN apk add --no-cache\
     py3-pip \
     curl &&\
     pip3 install --no-cache-dir \
-    j2cli==0.3.10 \
-    boto3==1.12.26 &&\
+    j2cli==0.3.10 &&\
     curl -o /usr/local/bin/waitforit -sSL https://github.com/maxcnunes/waitforit/releases/download/v2.4.1/waitforit-linux_amd64 && \
     chmod +x /usr/local/bin/waitforit &&\
     rm -rf /etc/nginx/nginx.conf /etc/nginx/conf.d/*