chore: added more setup configurations and linters

Author: Pythonian

.pre-commit-config.yaml

@@ -16,13 +16,8 @@ repos:
       - id: mixed-line-ending
       - id: requirements-txt-fixer
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.5.2
+    rev: v0.5.4
     hooks:
       - id: ruff
         args: [--fix]
       - id: ruff-format
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.10.1
-    hooks:
-      - id: mypy
-        additional_dependencies: [alembic==1.13.2]

Makefile

@@ -1,23 +1,73 @@
-.DEFAULT_GOAL := help
-ROOT_DIR := ./
+# Makefile for setting up the project
 
-hello:
+.DEFAULT_GOAL=help
+
+# Define commands to be explicitly invoked
+.PHONY: all venv install check clean help run migrate hello
+
+# Define the name of the virtual environment directory
+VENV_DIR = .venv
+
+# Define the python command for creating virtual environments
+PYTHON = python3
+
+# Define the pip executable within the virtual environment
+PIP = $(VENV_DIR)/bin/pip
+
+# Define the tox executable within the virtual environment
+TOX = $(VENV_DIR)/bin/tox
+
+# Define the pre-commit executable within the virtual environment
+PRE_COMMIT = $(VENV_DIR)/bin/pre-commit
+
+# Define the uvicorn executable within the virtual environment
+UVICORN = $(VENV_DIR)/bin/uvicorn
+
+# Define the alembic executable within the virtual environment
+ALEMBIC = $(VENV_DIR)/bin/alembic
+
+hello: ## Hello, World!
 	@echo "Hello, World!"
 
-help: ## Show this help
-	@egrep -h '\s##\s' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
+# Setup the development environment
+all: venv install check
+
+venv: ## Create a virtual environment
+	$(PYTHON) -m venv $(VENV_DIR)
+	@echo "Virtual environment created."
+
+install: ## Install development packages
+	$(PIP) install --upgrade pip
+	$(PIP) install -r requirements.txt
+	$(PRE_COMMIT) install
+	cp .env.example .env
+	@echo "Development packages has been setup."
+
+check: ## Run all checks using tox and pre-commit
+	$(TOX)
+	$(PRE_COMMIT) run --all-files
+	@echo "All checks passed"
 
 clean: ## Clean up the project of unneeded files
 	@echo "Cleaning up the project of unneeded files..."
-	@rm -rf .tox .mypy_cache .ruff_cache *.egg-info dist .cache htmlcov coverage.xml .coverage
-	@find . -name '*.pyc' -delete
-	@find . -name 'db.sqlite3' -delete
-	@find . -type d -name '__pycache__' -exec rm -r {} \+
+	@rm -rf $(VENV_DIR)
+	@rm -rf .cache
+	@rm -rf htmlcov coverage.xml .coverage
+	@rm -rf .tox
+	@rm -rf .mypy_cache
+	@rm -rf .ruff_cache
+	@rm -rf *.egg-info
+	@rm -rf dist
+	@find . -name "*.pyc" -delete
+	@find . -type d -name "__pycache__" -exec rm -r {} +
 	@echo "Clean up successfully completed."
 
+help: ## Show this help
+	@egrep -h '\s##\s' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
+
 run: ## Run the development server
-	@uvicorn main:app --reload
+	$(UVICORN) main:app --reload
 
 migrate: ## Run the database migration
-	@alembic revision --autogenerate
-	@alembic upgrade head
+	$(ALEMBIC) revision --autogenerate
+	$(ALEMBIC) upgrade head

api/db/database.py

@@ -1,10 +1,10 @@
 #!/usr/bin/env python3
 """The database module"""
 
-from sqlalchemy.orm import declarative_base, sessionmaker, scoped_session
 from sqlalchemy import create_engine
-from api.utils.settings import settings, BASE_DIR
+from sqlalchemy.orm import declarative_base, scoped_session, sessionmaker
 
+from api.utils.settings import BASE_DIR, settings
 
 DB_HOST = settings.DB_HOST
 DB_PORT = settings.DB_PORT
@@ -14,7 +14,7 @@
 DB_TYPE = settings.DB_TYPE
 
 
-def get_db_engine(test_mode: bool = False):
+def get_db_engine(test_mode: bool = False):  # type: ignore
     DATABASE_URL = f"postgresql://{DB_USER}:{DB_PASSWORD}@{DB_HOST}:{DB_PORT}/{DB_NAME}"
 
     if DB_TYPE == "sqlite" or test_mode:

api/utils/settings.py

@@ -1,7 +1,8 @@
-from pydantic_settings import BaseSettings
-from decouple import config
 from pathlib import Path
 
+from decouple import config
+from pydantic_settings import BaseSettings
+
 # Use this to build paths inside the project
 BASE_DIR = Path(__file__).resolve().parent
 

api/v1/models/blog.py

@@ -1,6 +1,6 @@
 """The Blog Post Model."""
 
-from sqlalchemy import Column, String, Text, Boolean, Integer, DateTime
+from sqlalchemy import Boolean, Column, DateTime, Integer, String, Text
 from sqlalchemy.sql import func
 
 from api.v1.models.base import Base

api/v1/routes/__init__.py

@@ -9,6 +9,7 @@
 """
 
 from fastapi import APIRouter
+
 from api.v1.routes.blog import blog
 
 api_version_one = APIRouter(prefix="/api/v1")

api/v1/routes/blog.py

@@ -1,12 +1,18 @@
-from typing import Any
+import logging
+
 from fastapi import APIRouter, Depends, HTTPException, Query, status
-from sqlalchemy.orm import Session
-from sqlalchemy.exc import SQLAlchemyError
 from sqlalchemy import not_
-from api.v1.models.blog import Blog
-from api.v1.schemas.blog import BlogCreateSchema, BlogResponseSchema
+from sqlalchemy.exc import SQLAlchemyError
+from sqlalchemy.orm import Session
+
 from api.db.database import get_db
-import logging
+from api.v1.models.blog import Blog
+from api.v1.schemas.blog import (
+    BlogCreateResponseSchema,
+    BlogCreateSchema,
+    BlogListItemResponseSchema,
+    BlogListResponseSchema,
+)
 
 blog = APIRouter(prefix="/blogs", tags=["Blog"])
 
@@ -15,10 +21,13 @@
 
 @blog.post(
     "",
-    response_model=BlogResponseSchema,
+    response_model=BlogCreateResponseSchema,
     status_code=status.HTTP_201_CREATED,
 )
-async def create_blog(blog: BlogCreateSchema, db: Session = Depends(get_db)):
+async def create_blog(
+    blog: BlogCreateSchema,
+    db: Session = Depends(get_db),
+) -> BlogCreateResponseSchema:
     try:
         existing_blog = db.query(Blog).filter(Blog.title == blog.title).first()
         if existing_blog:
@@ -38,7 +47,8 @@ async def create_blog(blog: BlogCreateSchema, db: Session = Depends(get_db)):
         db.commit()
         db.refresh(new_blog)
         logger.info(f"Blog post '{new_blog.title}' created successfully.")
-        return new_blog
+
+        return BlogCreateResponseSchema.model_validate(new_blog.__dict__)
 
     except HTTPException as http_err:
         logger.warning(f"HTTP error occurred: {http_err.detail}")
@@ -59,12 +69,16 @@ async def create_blog(blog: BlogCreateSchema, db: Session = Depends(get_db)):
         )
 
 
-@blog.get("", status_code=status.HTTP_200_OK)
+@blog.get(
+    "",
+    response_model=BlogListResponseSchema,
+    status_code=status.HTTP_200_OK,
+)
 async def list_blog(
     page: int = Query(1, ge=1),
     page_size: int = Query(10, ge=1, le=100),
     db: Session = Depends(get_db),
-) -> dict[str, Any]:
+) -> BlogListResponseSchema:
     try:
         offset = (page - 1) * page_size
         query = (
@@ -84,22 +98,22 @@ async def list_blog(
             prev_page = f"/api/v1/blogs?page={page - 1}&page_size={page_size}"
 
         results = [
-            {
-                "id": blog.id,
-                "title": blog.title,
-                "excerpt": blog.excerpt,
-                "image_url": blog.image_url,
-                "created_at": blog.created_at,
-            }
+            BlogListItemResponseSchema(
+                id=blog.id,
+                title=blog.title,
+                excerpt=blog.excerpt,
+                image_url=blog.image_url,
+                created_at=blog.created_at,
+            )
             for blog in blogs
         ]
 
-        return {
-            "count": total_count,
-            "next": next_page,
-            "previous": prev_page,
-            "results": results,
-        }
+        return BlogListResponseSchema(
+            count=total_count,
+            next=next_page,
+            previous=prev_page,
+            results=results,
+        )
 
     except SQLAlchemyError as e:
         logger.error(f"Database error occurred: {e}")

api/v1/schemas/blog.py

@@ -1,11 +1,13 @@
 """Blog Schema."""
 
-from pydantic import BaseModel, Field
 from datetime import datetime
+from typing import List, Optional
+
+from pydantic import BaseModel, Field
 
 
-class BlogResponseSchema(BaseModel):
-    """Schema for representing a blog post in the API response."""
+class BlogCreateResponseSchema(BaseModel):
+    """Schema for representing a created blog post in the API response."""
 
     id: int
     title: str
@@ -45,3 +47,26 @@ class BlogCreateSchema(BaseModel):
         max_length=255,
         description="URL of the blog post image",
     )
+
+
+class BlogListItemResponseSchema(BaseModel):
+    """Schema for representing a blog post item in the list response."""
+
+    id: int
+    title: str
+    excerpt: str
+    image_url: str
+    created_at: datetime
+
+    model_config = {"from_attributes": True}
+
+
+class BlogListResponseSchema(BaseModel):
+    """Schema for representing a blog post listing in the API response."""
+
+    count: int
+    next: Optional[str]
+    previous: Optional[str]
+    results: List[BlogListItemResponseSchema]
+
+    model_config = {"from_attributes": True}

main.py

@@ -1,8 +1,10 @@
-import uvicorn
 from contextlib import asynccontextmanager
+
+import uvicorn
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
 from starlette.requests import Request
+
 from api.db.database import Base, engine
 from api.utils.logging_config import setup_logging
 from api.v1.routes import api_version_one

mypy.ini

@@ -1,7 +1,42 @@
 [mypy]
+; Specifies the Python version to target for type checking.
 python_version = 3.10
+
+; Enables support for PEP 420 namespace packages.
 namespace_packages = True
+
+; Ensures mypy can find types for packages that use explicit relative imports.
 explicit_package_bases = True
 
-[mypy-fastapi_blog.*]
+; Ignores imports that cannot be resolved.
 ignore_missing_imports = True
+
+; Disallows subclassing classes that are typed with Any.
+disallow_subclassing_any = False
+
+; Disallows function definitions that do not have type annotations for all arguments and return types.
+disallow_incomplete_defs = True
+
+; Type-checks functions that do not have type annotations.
+check_untyped_defs = True
+
+; Issues warnings for redundant cast operations.
+warn_redundant_casts = True
+
+; Disables warnings about unused # type: ignore comments.
+warn_unused_ignores = False
+
+; Allows redefinition of variables within the same scope.
+allow_redefinition = True
+
+; Enables pretty formatting for mypy output.
+pretty = True
+
+; Controls how mypy handles imports.
+follow_imports = silent
+
+; Shows error codes in mypy output.
+show_error_codes = True
+
+; Displays column numbers in error messages.
+show_column_numbers = True