chore: updates and clean up (#10)

Author: nickatnight

.env_example

@@ -1,18 +1,24 @@
+# app
+ENCRYPT_KEY=
+SECRET_KEY=
 ENV=dev
 PROJECT_NAME=fastapi_backend_base
 VERSION=v1
 
+# Database
 POSTGRES_USER=fastapibackendbase
 POSTGRES_PASSWORD=fastapibackendbase0987
 POSTGRES_DB=fastapibackendbase
 POSTGRES_HOST=db
 POSTGRES_PORT=5432
 
-ENCRYPT_KEY=
-SECRET_KEY=
-
+# Nginx
 NGINX_HOST=localhost
 UPSTREAMS=/:backend:8000
+ENABLE_SSL=
+CERTBOT_EMAIL=
+DOMAIN_LIST=
 
+# Redis
 REDIS_HOST=redis
 REDIS_PORT=6379

README.md

@@ -2,12 +2,13 @@
     <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>
+    <a href="https://github.com/nickatnight/fastapi-backend-base/releases"><img alt="Release Status" src="https://img.shields.io/github/v/release/nickatnight/fastapi-backend-base"></a>
 </p>
 
 
 # fastapi-backend-base
 
-Small base project to build and deploy a fastapi backend..batteries included.
+Small base project I use to build and deploy fastapi backends..batteries included. Basically a stripped down version of [this](https://github.com/tiangolo/full-stack-fastapi-postgresql) and [this](https://github.com/jonra1993/fastapi-alembic-sqlmodel-async) repo...with some extra bells and whistles.
 
 ## Features
 * **Docker Compose** integration and optimization for local development.

backend/requirements/prod.txt

@@ -0,0 +1 @@
+-r base.txt

backend/requirements/staging.txt

@@ -0,0 +1 @@
+-r base.txt

backend/src/api/routes.py

@@ -1,7 +1,7 @@
 from fastapi import APIRouter, status
 from fastapi.responses import PlainTextResponse
 
-from src.api.v1 import health
+from src.api.v1 import health, meme
 
 
 home_router = APIRouter()
@@ -14,3 +14,4 @@ async def home():
 
 api_router = APIRouter()
 api_router.include_router(health.router)
+api_router.include_router(meme.router)

backend/src/api/v1/meme.py

@@ -0,0 +1,30 @@
+from fastapi import APIRouter, Depends, Query
+from sqlalchemy.ext.asyncio import AsyncSession
+from sqlmodel import select
+
+from src.db.session import get_session
+from src.models.meme import Meme
+from src.schemas.common import IGetResponseBase
+from src.schemas.meme import IMemeRead
+
+
+router = APIRouter()
+
+
+@router.get(
+    "/meme/list",
+    response_description="List all meme instances",
+    response_model=IGetResponseBase[IMemeRead],
+    tags=["memes"],
+)
+async def memes(
+    skip: int = Query(0, ge=0),
+    limit: int = Query(100, ge=1),
+    session: AsyncSession = Depends(get_session),
+) -> IGetResponseBase[IMemeRead]:
+    result = await session.execute(
+        select(Meme).offset(skip).limit(limit).order_by(Meme.created_at.desc())
+    )
+    memes = result.scalars().all()
+
+    return IGetResponseBase[IMemeRead](data=memes)

backend/src/db/session.py

@@ -1,5 +1,3 @@
-from fastapi import HTTPException
-from sqlalchemy.exc import SQLAlchemyError
 from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
 from sqlalchemy.orm import sessionmaker
 from sqlmodel import SQLModel
@@ -34,14 +32,4 @@ async def get_session() -> AsyncSession:
     # after commit.
     async_session = sessionmaker(engine, class_=AsyncSession, expire_on_commit=False)
     async with async_session() as session:
-        try:
-            yield session
-            await session.commit()
-        except SQLAlchemyError as sql_ex:
-            await session.rollback()
-            raise sql_ex
-        except HTTPException as http_ex:
-            await session.rollback()
-            raise http_ex
-        finally:
-            await session.close()
+        yield session

backend/src/models/__init__.py

@@ -0,0 +1,16 @@
+import uuid as uuid_pkg
+from datetime import datetime
+from typing import Optional
+
+from sqlmodel import Field, SQLModel
+
+
+class BaseModel(SQLModel):
+    id: uuid_pkg.UUID = Field(
+        default_factory=uuid_pkg.uuid4,
+        primary_key=True,
+        index=True,
+        nullable=False,
+    )
+    updated_at: Optional[datetime]
+    created_at: Optional[datetime]

backend/src/models/base.py

@@ -0,0 +1,38 @@
+from datetime import datetime, timezone
+
+from pydantic import BaseConfig, validator
+from sqlmodel import Field, SQLModel
+
+from src.models.base import BaseModel
+
+
+class MemeBase(SQLModel):
+    submission_id: str = Field(...)
+    submission_url: str = Field(...)
+    submission_title: str = Field(...)
+    permalink: str = Field(...)
+    author: str = Field(...)
+    timestamp: datetime = Field(...)
+
+    class Config(BaseConfig):
+        json_encoder = {
+            datetime: lambda dt: dt.replace(tzinfo=timezone.utc).isoformat(),
+        }
+        schema_extra = {
+            "example": {
+                "id": "1234-43143-3134-13423",
+                "submission_id": "nny218",
+                "submission_title": "This community is so nice. Helps me hodl.",
+                "submission_url": "https://i.redd.it/gdv6tbamkb271.jpg",
+                "permalink": "/r/dogecoin/comments/nnvakd/still_holding_keep_the_faith/",
+                "author": "42points",
+                "timestamp": "2004-09-16T23:59:58.75",
+                "created_at": "2004-09-16T23:59:58.75",
+            }
+        }
+
+
+class Meme(BaseModel, MemeBase, table=True):
+    @validator("created_at", pre=True, always=True)
+    def set_created_at_now(cls, v):
+        return v or datetime.now()