docs: major updates (#7)

* feat: major updates

* feat: major updates

* feat: major updates

* infra: revert GHA steps

* GHS fix

* chore: remove redundant flake8 config

* chore fixes

Author: nickatnight

.env_example

@@ -14,4 +14,5 @@ SECRET_KEY=
 NGINX_HOST=localhost
 UPSTREAMS=/:backend:8000
 
-REDIS_HOST=redis://redis:6379
+REDIS_HOST=redis
+REDIS_PORT=6379

.github/workflows/main.yml

@@ -18,7 +18,7 @@ jobs:
         uses: actions/checkout@v2
       - name: Start linter
         run: |
-          docker run --rm -w="/code/backend" -v $(pwd):/code alpine/flake8:3.9.2 .
+          docker run --rm -w="/code/backend" -v $(pwd):/code alpine/flake8:3.9.2 --config=pyproject.toml .
 
   black:
     runs-on: ubuntu-20.04
@@ -34,10 +34,26 @@ jobs:
         working-directory: ./backend
         run: |
           pip install black==22.6.0
-          black --check .
+          black --check --config=pyproject.toml .
+
+  isort:
+    runs-on: ubuntu-20.04
+    name: isort imports
+    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 isort==5.10.1
+          isort --settings-path=pyproject.toml src
 
   create-release:
-    needs: [linter, black]
+    needs: [linter, black, isort]
     runs-on: ubuntu-20.04
     steps:
       - name: checkout

.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+default_language_version:
+    python: python3.9
+
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: debug-statements
+    -   id: requirements-txt-fixer
+-   repo: https://github.com/psf/black
+    rev: 22.6.0
+    hooks:
+    -   id: black
+        args: ["--config=./backend/pyproject.toml"]
+-   repo: https://github.com/PyCQA/flake8
+    rev: 5.0.4
+    hooks:
+    -   id: flake8
+        args: ["--config=./backend/pyproject.toml"]
+-   repo: https://github.com/PyCQA/isort
+    rev: 5.10.1
+    hooks:
+    -   id: isort
+        args: ["--settings-path=./backend/pyproject.toml"]

README.md

@@ -20,20 +20,30 @@ Small base project to build and deploy a fastapi backend..batteries included.
     * **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
+* **SQLModel** Library for interacting with SQL databases from Python code, with Python objects. It is designed to be intuitive, easy to use, highly compatible, and robust
 * **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.
+* **PostgresSQL** Powerfull open source object-relational database
+* **AsyncPG** Database interface library designed specifically for PostgreSQL and Python/asyncio.
+* **Redis** In-memory data structure store, used as a distributed, in-memory key–value database, cache and message broker.
 
+<p align="center">
+    <a href="#">
+        <img alt="Architecture Workflow" src="docs/fastapi-backend-base.png">
+    </a>
+</p>
 
 ## Usage
 1. `git clone https://github.com/nickatnight/fastapi-backend-base.git`
 2. `cd fastapi-backend-base`
 3. `mv .env_example .env`
 4. `docker compose up --build`
-5. visit `http://localhost:8000` for uvicorn server, or `http://localhost` for nginx
+5. visit `http://localhost:8000` for uvicorn server, or `http://localhost` for nginx proxy
 
 ## Deploy
+A common scenario is to use an orchestration tool, such as docker swarm, to deploy your containers to the cloud (DigitalOcean)
+
+## Configuration
+
+## Development

backend/.flake8

@@ -1,13 +1,16 @@
+[flake8]
+max-line-length = 100
+exclude = '__init__.py,__pycache__,git'
+ignore = 'F403,F405,W605,W503,E203,E231'
+
+[tool.isort]
+multi_line_output = 3
+lines_after_imports = 2
+line_length = 88
+include_trailing_comma = true
+sections = 'FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER'
+
 [tool.black]
 line-length = 100
 include = '\.pyi?$'
-exclude = '''
-/(
-    \.git
-  | \.hg
-  | \.mypy_cache
-  | \.tox
-  | \.venv
-  | _build
-)/
-'''
+exclude = '(\.git|\.hg|\.mypy_cache|\.tox|\.venv|_build)'

backend/pyproject.toml

@@ -1,6 +1,6 @@
 -r base.txt
-
-pytest==6.2.3
 black==22.6.0
-flake8==3.9.2
+flake8==5.0.4
+isort==5.10.1
+pytest==6.2.3
 pytest-cov==2.12.0

backend/requirements/dev.txt

@@ -1,5 +1,6 @@
 from fastapi import APIRouter
 
+
 # from fastapi_limiter.depends import RateLimiter
 
 

backend/src/api/v1/health.py

@@ -18,7 +18,10 @@ class Settings(BaseSettings):
     POSTGRES_PASSWORD: str = Field(..., env="POSTGRES_PASSWORD")
     POSTGRES_DB: str = Field(..., env="POSTGRES_DB")
     POSTGRES_PORT: str = Field(..., env="POSTGRES_PORT")
+
     REDIS_HOST: str = Field(..., env="REDIS_HOST")
+    REDIS_PORT: str = Field(..., env="REDIS_PORT")
+    REDIS_URL: str = f"redis://{REDIS_HOST}:{REDIS_PORT}/0"
 
     VERSION: str = Field(..., env="VERSION")
 

backend/src/core/config.py

@@ -1,8 +1,8 @@
 from fastapi import HTTPException
-from sqlmodel import SQLModel
 from sqlalchemy.exc import SQLAlchemyError
 from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
 from sqlalchemy.orm import sessionmaker
+from sqlmodel import SQLModel
 
 from src.core.config import settings