Create simple todo app with FastAPI and SQLite

README.md

@@ -1,3 +1,139 @@
-# FastAPI Application
+# Simple Todo App
 
-This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform.
+A simple REST API for managing todo items, built with FastAPI and SQLite.
+
+## Features
+
+- Create, read, update, and delete todo items
+- SQLite database with SQLAlchemy ORM
+- Alembic for database migrations
+- Health check endpoint
+- API documentation
+
+## Requirements
+
+- Python 3.8+
+- FastAPI
+- SQLAlchemy
+- Alembic
+- Uvicorn
+- SQLite
+
+## Setup
+
+1. Clone the repository:
+```bash
+git clone https://github.com/yourusername/simpletodoapp.git
+cd simpletodoapp
+```
+
+2. Install dependencies:
+```bash
+pip install -r requirements.txt
+```
+
+3. Run database migrations:
+```bash
+alembic upgrade head
+```
+
+4. Start the server:
+```bash
+uvicorn main:app --reload
+```
+
+The API will be available at http://localhost:8000
+
+## API Documentation
+
+API documentation is available at:
+- Swagger UI: http://localhost:8000/docs
+- ReDoc: http://localhost:8000/redoc
+
+## API Endpoints
+
+### Root
+
+- `GET /` - Returns basic app information
+
+### Health Check
+
+- `GET /health` - Returns the health status of the API
+
+### Todo Operations
+
+- `GET /api/v1/todos` - Get all todos
+- `POST /api/v1/todos` - Create a new todo
+- `GET /api/v1/todos/{todo_id}` - Get a specific todo
+- `PUT /api/v1/todos/{todo_id}` - Update a todo
+- `DELETE /api/v1/todos/{todo_id}` - Delete a todo
+
+## Example Usage
+
+### Create a Todo
+
+```bash
+curl -X 'POST' \
+  'http://localhost:8000/api/v1/todos/' \
+  -H 'accept: application/json' \
+  -H 'Content-Type: application/json' \
+  -d '{
+  "title": "Buy groceries",
+  "description": "Milk, eggs, bread",
+  "completed": false
+}'
+```
+
+### Get All Todos
+
+```bash
+curl -X 'GET' \
+  'http://localhost:8000/api/v1/todos/' \
+  -H 'accept: application/json'
+```
+
+### Mark Todo as Completed
+
+```bash
+curl -X 'PUT' \
+  'http://localhost:8000/api/v1/todos/1' \
+  -H 'accept: application/json' \
+  -H 'Content-Type: application/json' \
+  -d '{
+  "completed": true
+}'
+```
+
+## Project Structure
+
+```
+simpletodoapp/
+├── app/
+│   ├── api/
+│   │   └── api_v1/
+│   │       ├── endpoints/
+│   │       │   └── todos.py
+│   │       └── api.py
+│   ├── core/
+│   │   └── config.py
+│   ├── crud/
+│   │   ├── base.py
+│   │   └── todo.py
+│   ├── db/
+│   │   ├── base.py
+│   │   ├── base_class.py
+│   │   └── session.py
+│   ├── models/
+│   │   └── todo.py
+│   └── schemas/
+│       └── todo.py
+├── migrations/
+│   └── versions/
+│       └── 001_create_todos_table.py
+├── storage/
+│   └── db/
+│       └── db.sqlite
+├── alembic.ini
+├── main.py
+└── requirements.txt
+```

alembic.ini

@@ -0,0 +1,85 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = migrations
+
+# template used to generate migration files
+# file_template = %%(rev)s_%%(slug)s
+
+# timezone to use when rendering the date
+# within the migration file as well as the filename.
+# string value is passed to dateutil.tz.gettz()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the
+# "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; this defaults
+# to migrations/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path
+# version_locations = %(here)s/bar %(here)s/bat migrations/versions
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+# SQLite URL
+sqlalchemy.url = sqlite:////app/storage/db/db.sqlite
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

app/api/api_v1/api.py

@@ -0,0 +1,6 @@
+from fastapi import APIRouter
+
+from app.api.api_v1.endpoints import todos
+
+api_router = APIRouter(prefix="/api/v1")
+api_router.include_router(todos.router, prefix="/todos", tags=["todos"])

app/api/api_v1/endpoints/todos.py

@@ -0,0 +1,96 @@
+from typing import Any, List
+
+from fastapi import APIRouter, Depends, HTTPException, status
+from sqlalchemy.orm import Session
+
+from app import crud, schemas
+from app.db.session import get_db
+
+router = APIRouter()
+
+
+@router.get("/", response_model=List[schemas.Todo])
+def read_todos(
+    db: Session = Depends(get_db),
+    skip: int = 0,
+    limit: int = 100,
+) -> Any:
+    """
+    Retrieve all todos.
+    """
+    todos = crud.todo.get_multi(db, skip=skip, limit=limit)
+    return todos
+
+
+@router.post("/", response_model=schemas.Todo, status_code=status.HTTP_201_CREATED)
+def create_todo(
+    *,
+    db: Session = Depends(get_db),
+    todo_in: schemas.TodoCreate,
+) -> Any:
+    """
+    Create new todo.
+    """
+    todo = crud.todo.create(db=db, obj_in=todo_in)
+    return todo
+
+
+@router.get("/{todo_id}", response_model=schemas.Todo)
+def read_todo(
+    *,
+    db: Session = Depends(get_db),
+    todo_id: int,
+) -> Any:
+    """
+    Get todo by ID.
+    """
+    todo = crud.todo.get(db=db, id=todo_id)
+    if not todo:
+        raise HTTPException(
+            status_code=status.HTTP_404_NOT_FOUND,
+            detail="Todo not found",
+        )
+    return todo
+
+
+@router.put("/{todo_id}", response_model=schemas.Todo)
+def update_todo(
+    *,
+    db: Session = Depends(get_db),
+    todo_id: int,
+    todo_in: schemas.TodoUpdate,
+) -> Any:
+    """
+    Update a todo.
+    """
+    todo = crud.todo.get(db=db, id=todo_id)
+    if not todo:
+        raise HTTPException(
+            status_code=status.HTTP_404_NOT_FOUND,
+            detail="Todo not found",
+        )
+    todo = crud.todo.update(db=db, db_obj=todo, obj_in=todo_in)
+    return todo
+
+
+@router.delete(
+    "/{todo_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+    response_model=None
+)
+def delete_todo(
+    *,
+    db: Session = Depends(get_db),
+    todo_id: int,
+) -> Any:
+    """
+    Delete a todo.
+    """
+    todo = crud.todo.get(db=db, id=todo_id)
+    if not todo:
+        raise HTTPException(
+            status_code=status.HTTP_404_NOT_FOUND,
+            detail="Todo not found",
+        )
+    crud.todo.remove(db=db, id=todo_id)
+    return None

app/core/config.py

@@ -0,0 +1,24 @@
+import os
+from pathlib import Path
+
+from pydantic_settings import BaseSettings
+
+
+class Settings(BaseSettings):
+    # Application settings
+    PROJECT_NAME: str = "Simple Todo App"
+    API_V1_STR: str = "/api/v1"
+
+    # Database settings
+    DB_DIR: Path = Path("/app/storage/db")
+    SQLALCHEMY_DATABASE_URL: str = f"sqlite:///{DB_DIR}/db.sqlite"
+
+    class Config:
+        env_file = ".env"
+        case_sensitive = True
+
+
+settings = Settings()
+
+# Ensure DB directory exists
+os.makedirs(settings.DB_DIR, exist_ok=True)

app/crud/__init__.py

@@ -0,0 +1,3 @@
+from app.crud.todo import todo  # noqa
+
+__all__ = ["todo"]

app/crud/base.py

@@ -0,0 +1,83 @@
+from typing import Any, Dict, Generic, List, Optional, Type, TypeVar, Union
+
+from fastapi.encoders import jsonable_encoder
+from pydantic import BaseModel
+from sqlalchemy.orm import Session
+
+from app.db.base import Base
+
+ModelType = TypeVar("ModelType", bound=Base)
+CreateSchemaType = TypeVar("CreateSchemaType", bound=BaseModel)
+UpdateSchemaType = TypeVar("UpdateSchemaType", bound=BaseModel)
+
+
+class CRUDBase(Generic[ModelType, CreateSchemaType, UpdateSchemaType]):
+    """
+    CRUD object with default methods to Create, Read, Update, Delete (CRUD).
+    """
+
+    def __init__(self, model: Type[ModelType]) -> None:
+        """
+        CRUD object with default methods to Create, Read, Update, Delete (CRUD).
+
+        **Parameters**
+        * `model`: A SQLAlchemy model class
+        """
+        self.model = model
+
+    def get(self, db: Session, id: Any) -> Optional[ModelType]:
+        """
+        Get an object by ID.
+        """
+        return db.query(self.model).filter(self.model.id == id).first()
+
+    def get_multi(
+        self, db: Session, *, skip: int = 0, limit: int = 100
+    ) -> List[ModelType]:
+        """
+        Get multiple objects with pagination.
+        """
+        return db.query(self.model).offset(skip).limit(limit).all()
+
+    def create(self, db: Session, *, obj_in: CreateSchemaType) -> ModelType:
+        """
+        Create a new object.
+        """
+        obj_in_data = jsonable_encoder(obj_in)
+        db_obj = self.model(**obj_in_data)
+        db.add(db_obj)
+        db.commit()
+        db.refresh(db_obj)
+        return db_obj
+
+    def update(
+        self,
+        db: Session,
+        *,
+        db_obj: ModelType,
+        obj_in: Union[UpdateSchemaType, Dict[str, Any]]
+    ) -> ModelType:
+        """
+        Update an object.
+        """
+        obj_data = jsonable_encoder(db_obj)
+        if isinstance(obj_in, dict):
+            update_data = obj_in
+        else:
+            update_data = obj_in.model_dump(exclude_unset=True)
+        for field in obj_data:
+            if field in update_data:
+                setattr(db_obj, field, update_data[field])
+        db.add(db_obj)
+        db.commit()
+        db.refresh(db_obj)
+        return db_obj
+
+    def remove(self, db: Session, *, id: int) -> ModelType:
+        """
+        Remove an object.
+        """
+        obj = db.query(self.model).get(id)
+        db.delete(obj)
+        db.commit()
+        return obj

app/crud/todo.py

@@ -0,0 +1,13 @@
+from app.crud.base import CRUDBase
+from app.models.todo import Todo
+from app.schemas.todo import TodoCreate, TodoUpdate
+
+
+class CRUDTodo(CRUDBase[Todo, TodoCreate, TodoUpdate]):
+    """
+    CRUD operations for Todo items.
+    """
+    pass
+
+
+todo = CRUDTodo(Todo)

app/db/base.py

@@ -0,0 +1,3 @@
+from sqlalchemy.ext.declarative import declarative_base
+
+Base = declarative_base()

app/db/base_class.py

@@ -0,0 +1,19 @@
+from sqlalchemy import Column, DateTime, Integer
+from sqlalchemy.sql import func
+
+from app.db.base import Base
+
+
+class BaseModel(Base):
+    """
+    Base model class that includes common columns for all models.
+    """
+    __abstract__ = True
+
+    id = Column(Integer, primary_key=True, index=True)
+    created_at = Column(DateTime(timezone=True), server_default=func.now())
+    updated_at = Column(
+        DateTime(timezone=True),
+        server_default=func.now(),
+        onupdate=func.now()
+    )

app/db/session.py

@@ -0,0 +1,29 @@
+from pathlib import Path
+
+from sqlalchemy import create_engine
+from sqlalchemy.orm import sessionmaker
+
+# Ensure DB directory exists
+DB_DIR = Path("/app/storage/db")
+DB_DIR.mkdir(parents=True, exist_ok=True)
+
+SQLALCHEMY_DATABASE_URL = f"sqlite:///{DB_DIR}/db.sqlite"
+
+engine = create_engine(
+    SQLALCHEMY_DATABASE_URL,
+    connect_args={"check_same_thread": False}  # Only needed for SQLite
+)
+
+SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
+
+
+def get_db() -> SessionLocal:
+    """
+    Dependency function to get a database session.
+    This function will be used as a FastAPI dependency in route functions.
+    """
+    db = SessionLocal()
+    try:
+        yield db
+    finally:
+        db.close()

app/models/__init__.py

@@ -0,0 +1,3 @@
+from app.models.todo import Todo  # noqa
+
+__all__ = ["Todo"]

app/models/todo.py

@@ -0,0 +1,14 @@
+from sqlalchemy import Boolean, Column, String, Text
+
+from app.db.base_class import BaseModel
+
+
+class Todo(BaseModel):
+    """
+    Todo item model.
+    """
+    __tablename__ = "todos"
+
+    title = Column(String(255), nullable=False, index=True)
+    description = Column(Text, nullable=True)
+    completed = Column(Boolean, default=False)

app/schemas/__init__.py

@@ -0,0 +1,3 @@
+from app.schemas.todo import Todo, TodoCreate, TodoUpdate  # noqa
+
+__all__ = ["Todo", "TodoCreate", "TodoUpdate"]

app/schemas/todo.py

@@ -0,0 +1,48 @@
+from datetime import datetime
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+
+class TodoBase(BaseModel):
+    """
+    Base schema for Todo items.
+    """
+    title: str = Field(..., min_length=1, max_length=255)
+    description: Optional[str] = None
+    completed: bool = False
+
+
+class TodoCreate(TodoBase):
+    """
+    Schema for creating a new Todo item.
+    """
+    pass
+
+
+class TodoUpdate(BaseModel):
+    """
+    Schema for updating an existing Todo item.
+    """
+    title: Optional[str] = Field(None, min_length=1, max_length=255)
+    description: Optional[str] = None
+    completed: Optional[bool] = None
+
+
+class TodoInDBBase(TodoBase):
+    """
+    Base schema for Todo items in the database.
+    """
+    id: int
+    created_at: datetime
+    updated_at: datetime
+
+    class Config:
+        from_attributes = True
+
+
+class Todo(TodoInDBBase):
+    """
+    Schema for returning a Todo item.
+    """
+    pass

main.py

@@ -0,0 +1,50 @@
+import uvicorn
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+
+from app.api.api_v1.api import api_router
+from app.core.config import settings
+
+app = FastAPI(
+    title=settings.PROJECT_NAME,
+    description="A simple Todo API",
+    version="0.1.0",
+    openapi_url="/openapi.json",
+    docs_url="/docs",
+    redoc_url="/redoc",
+)
+
+# Set up CORS
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=["*"],
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"],
+)
+
+app.include_router(api_router)
+
+
+@app.get("/", tags=["Root"])
+async def root() -> dict:
+    """
+    Root endpoint that returns basic app information.
+    """
+    return {
+        "title": settings.PROJECT_NAME,
+        "docs": "/docs",
+        "health": "/health"
+    }
+
+
+@app.get("/health", tags=["Health"])
+async def health_check() -> dict:
+    """
+    Health check endpoint to verify the service is running.
+    """
+    return {"status": "ok"}
+
+
+if __name__ == "__main__":
+    uvicorn.run("main:app", host="0.0.0.0", port=8000, reload=True)

migrations/env.py

@@ -0,0 +1,86 @@
+import os
+import sys
+from logging.config import fileConfig
+
+from alembic import context
+from sqlalchemy import engine_from_config, pool
+
+# Add the parent directory to sys.path to import from app
+sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+
+# Import the Base model for SQLAlchemy
+from app.db.base import Base
+from app.models import Todo  # noqa
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+target_metadata = Base.metadata
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    connectable = engine_from_config(
+        config.get_section(config.config_ini_section),
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    with connectable.connect() as connection:
+        is_sqlite = connection.dialect.name == 'sqlite'
+        context.configure(
+            connection=connection,
+            target_metadata=target_metadata,
+            render_as_batch=is_sqlite,  # Key configuration for SQLite
+            compare_type=True,
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

migrations/script.py.mako

@@ -0,0 +1,24 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision = ${repr(up_revision)}
+down_revision = ${repr(down_revision)}
+branch_labels = ${repr(branch_labels)}
+depends_on = ${repr(depends_on)}
+
+
+def upgrade():
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade():
+    ${downgrades if downgrades else "pass"}

migrations/versions/001_create_todos_table.py

@@ -0,0 +1,46 @@
+"""Create todos table
+
+Revision ID: 001
+Revises:
+Create Date: 2023-10-28
+
+"""
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = '001'
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    op.create_table(
+        'todos',
+        sa.Column('id', sa.Integer(), nullable=False),
+        sa.Column(
+            'created_at',
+            sa.DateTime(timezone=True),
+            server_default=sa.text('(CURRENT_TIMESTAMP)'),
+            nullable=True
+        ),
+        sa.Column(
+            'updated_at',
+            sa.DateTime(timezone=True),
+            server_default=sa.text('(CURRENT_TIMESTAMP)'),
+            nullable=True
+        ),
+        sa.Column('title', sa.String(length=255), nullable=False),
+        sa.Column('description', sa.Text(), nullable=True),
+        sa.Column('completed', sa.Boolean(), default=False, nullable=True),
+        sa.PrimaryKeyConstraint('id')
+    )
+    op.create_index(op.f('ix_todos_id'), 'todos', ['id'], unique=False)
+    op.create_index(op.f('ix_todos_title'), 'todos', ['title'], unique=False)
+
+
+def downgrade() -> None:
+    op.drop_index(op.f('ix_todos_title'), table_name='todos')
+    op.drop_index(op.f('ix_todos_id'), table_name='todos')
+    op.drop_table('todos')

pyproject.toml

@@ -0,0 +1,13 @@
+[tool.ruff]
+line-length = 88
+target-version = "py38"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "B", "C4", "UP", "N", "ANN", "FBT", "W", "YTT", "SIM", "ARG"]
+ignore = ["ANN401", "B008"]
+
+[tool.ruff.lint.isort]
+known-third-party = ["fastapi", "pydantic", "sqlalchemy", "alembic"]
+
+[tool.ruff.lint.mccabe]
+max-complexity = 10

requirements.txt

@@ -0,0 +1,7 @@
+fastapi>=0.104.1
+uvicorn>=0.24.0
+sqlalchemy>=2.0.23
+pydantic>=2.4.2
+alembic>=1.12.1
+python-dotenv>=1.0.0
+ruff>=0.1.3