Implement FastAPI Todo Application

README.md

@@ -1,3 +1,82 @@
-# FastAPI Application
+# Simple Todo Application API
 
-This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform.
+This is a REST API for a simple todo application built with FastAPI and SQLite.
+
+## Features
+
+- Create, read, update, and delete todo items
+- Health endpoint for application monitoring
+- API documentation via Swagger UI and ReDoc
+- Database migrations using Alembic
+- SQLite database for data storage
+
+## Project Structure
+
+```
+├── app/
+│   ├── api/           # API endpoints
+│   ├── crud/          # Database CRUD operations
+│   ├── db/            # Database connection and utilities
+│   ├── models/        # SQLAlchemy models
+│   └── schemas/       # Pydantic schemas
+├── migrations/        # Alembic migration scripts
+├── main.py            # FastAPI application entry point
+├── alembic.ini        # Alembic configuration
+└── requirements.txt   # Project dependencies
+```
+
+## Installation
+
+1. Clone the repository
+2. Install the dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+## Running the Application
+
+Start the application with:
+
+```bash
+uvicorn main:app --reload
+```
+
+The API will be available at http://localhost:8000
+
+## API Documentation
+
+- Swagger UI: http://localhost:8000/docs
+- ReDoc: http://localhost:8000/redoc
+
+## API Endpoints
+
+- `GET /`: Root endpoint with API information
+- `GET /health`: Health check endpoint
+- `GET /todos`: Get all todo items
+- `POST /todos`: Create a new todo item
+- `GET /todos/{id}`: Get a specific todo item
+- `PATCH /todos/{id}`: Update a todo item
+- `DELETE /todos/{id}`: Delete a todo item
+
+## Database Migrations
+
+Run migrations with:
+
+```bash
+alembic upgrade head
+```
+
+## Development
+
+This project uses Ruff for linting. Run the linter with:
+
+```bash
+ruff check .
+```
+
+To automatically fix issues:
+
+```bash
+ruff check --fix .
+```

alembic.ini

@@ -0,0 +1,112 @@
+# 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
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python-dateutil library that can be
+# installed by adding `alembic[tz]` to the pip requirements
+# 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.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:migrations/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+version_path_separator = os  # Use os.pathsep. Default configuration used on Windows.
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+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
+
+# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = %(here)s/.venv/bin/ruff
+# ruff.options = --fix 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/__init__.py

@@ -0,0 +1,3 @@
+from app.api.todos import router as todos_router
+
+__all__ = ["todos_router"]

app/api/todos.py

@@ -0,0 +1,64 @@
+from typing import List
+
+from fastapi import APIRouter, Depends, HTTPException, status
+from sqlalchemy.orm import Session
+
+from app.crud import todo as todo_crud
+from app.db.database import get_db
+from app.schemas.todo import Todo, TodoCreate, TodoUpdate
+
+router = APIRouter(
+    prefix="/todos",
+    tags=["todos"],
+    responses={404: {"description": "Todo not found"}},
+)
+
+
+@router.post("/", response_model=Todo, status_code=status.HTTP_201_CREATED)
+def create_todo(todo: TodoCreate, db: Session = Depends(get_db)):
+    """
+    Create a new todo item.
+    """
+    return todo_crud.create_todo(db=db, todo=todo)
+
+
+@router.get("/", response_model=List[Todo])
+def read_todos(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)):
+    """
+    Retrieve all todo items with pagination.
+    """
+    todos = todo_crud.get_todos(db, skip=skip, limit=limit)
+    return todos
+
+
+@router.get("/{todo_id}", response_model=Todo)
+def read_todo(todo_id: int, db: Session = Depends(get_db)):
+    """
+    Retrieve a specific todo item by ID.
+    """
+    db_todo = todo_crud.get_todo(db, todo_id=todo_id)
+    if db_todo is None:
+        raise HTTPException(status_code=404, detail="Todo not found")
+    return db_todo
+
+
+@router.patch("/{todo_id}", response_model=Todo)
+def update_todo(todo_id: int, todo: TodoUpdate, db: Session = Depends(get_db)):
+    """
+    Update a todo item.
+    """
+    db_todo = todo_crud.update_todo(db, todo_id=todo_id, todo=todo)
+    if db_todo is None:
+        raise HTTPException(status_code=404, detail="Todo not found")
+    return db_todo
+
+
+@router.delete("/{todo_id}", status_code=status.HTTP_204_NO_CONTENT)
+def delete_todo(todo_id: int, db: Session = Depends(get_db)):
+    """
+    Delete a todo item.
+    """
+    success = todo_crud.delete_todo(db, todo_id=todo_id)
+    if not success:
+        raise HTTPException(status_code=404, detail="Todo not found")
+    return None

app/crud/__init__.py

@@ -0,0 +1,3 @@
+from app.crud.todo import create_todo, delete_todo, get_todo, get_todos, update_todo
+
+__all__ = ["create_todo", "delete_todo", "get_todo", "get_todos", "update_todo"]

app/crud/todo.py

@@ -0,0 +1,50 @@
+from typing import List, Optional
+
+from sqlalchemy.orm import Session
+
+from app.models.todo import Todo
+from app.schemas.todo import TodoCreate, TodoUpdate
+
+
+def get_todo(db: Session, todo_id: int) -> Optional[Todo]:
+    return db.query(Todo).filter(Todo.id == todo_id).first()
+
+
+def get_todos(db: Session, skip: int = 0, limit: int = 100) -> List[Todo]:
+    return db.query(Todo).offset(skip).limit(limit).all()
+
+
+def create_todo(db: Session, todo: TodoCreate) -> Todo:
+    db_todo = Todo(
+        title=todo.title,
+        description=todo.description,
+        completed=todo.completed,
+    )
+    db.add(db_todo)
+    db.commit()
+    db.refresh(db_todo)
+    return db_todo
+
+
+def update_todo(db: Session, todo_id: int, todo: TodoUpdate) -> Optional[Todo]:
+    db_todo = get_todo(db, todo_id)
+    if db_todo is None:
+        return None
+    
+    todo_data = todo.model_dump(exclude_unset=True)
+    for key, value in todo_data.items():
+        setattr(db_todo, key, value)
+    
+    db.commit()
+    db.refresh(db_todo)
+    return db_todo
+
+
+def delete_todo(db: Session, todo_id: int) -> bool:
+    db_todo = get_todo(db, todo_id)
+    if db_todo is None:
+        return False
+    
+    db.delete(db_todo)
+    db.commit()
+    return True

app/db/database.py

@@ -0,0 +1,27 @@
+from pathlib import Path
+from sqlalchemy import create_engine
+from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.orm import sessionmaker
+
+# Create database directory
+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}
+)
+
+SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
+
+Base = declarative_base()
+
+# Dependency
+def get_db():
+    db = SessionLocal()
+    try:
+        yield db
+    finally:
+        db.close()

app/models/__init__.py

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

app/models/todo.py

@@ -0,0 +1,15 @@
+from sqlalchemy import Boolean, Column, Integer, String, DateTime
+from sqlalchemy.sql import func
+
+from app.db.database import Base
+
+
+class Todo(Base):
+    __tablename__ = "todos"
+
+    id = Column(Integer, primary_key=True, index=True)
+    title = Column(String, index=True)
+    description = Column(String)
+    completed = Column(Boolean, default=False)
+    created_at = Column(DateTime(timezone=True), server_default=func.now())
+    updated_at = Column(DateTime(timezone=True), onupdate=func.now())

app/schemas/__init__.py

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

app/schemas/todo.py

@@ -0,0 +1,30 @@
+from datetime import datetime
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class TodoBase(BaseModel):
+    title: str
+    description: Optional[str] = None
+    completed: bool = False
+
+
+class TodoCreate(TodoBase):
+    pass
+
+
+class TodoUpdate(BaseModel):
+    title: Optional[str] = None
+    description: Optional[str] = None
+    completed: Optional[bool] = None
+
+
+class Todo(TodoBase):
+    id: int
+    created_at: datetime
+    updated_at: Optional[datetime] = None
+
+    class Config:
+        orm_mode = True
+        from_attributes = True

main.py

@@ -0,0 +1,46 @@
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+
+from app.api import todos_router
+from app.db.database import Base, engine
+
+# Create tables in database
+Base.metadata.create_all(bind=engine)
+
+app = FastAPI(
+    title="Simple Todo Application",
+    description="A simple todo application API built with FastAPI",
+    version="0.1.0",
+)
+
+# Setup CORS
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=["*"],
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"],
+)
+
+# Include routers
+app.include_router(todos_router)
+
+# Health endpoint
+@app.get("/health", tags=["Health"])
+def health_check():
+    """
+    Health check endpoint to verify the API is running
+    """
+    return {"status": "healthy"}
+
+
+@app.get("/", tags=["Root"])
+def read_root():
+    """
+    Root endpoint with links to API documentation
+    """
+    return {
+        "message": "Welcome to the Simple Todo Application API",
+        "documentation": "/docs",
+        "alternative_doc": "/redoc",
+    }

migrations/env.py

@@ -0,0 +1,77 @@
+from logging.config import fileConfig
+
+from alembic import context
+from sqlalchemy import engine_from_config, pool
+from app.db.database import Base
+# Import models here so Alembic can detect them
+import app.models.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():
+    """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():
+    """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:
+        context.configure(
+            connection=connection, target_metadata=target_metadata
+        )
+
+        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/initial_migration.py

@@ -0,0 +1,36 @@
+"""Create todos table
+
+Revision ID: 1a39b3495612
+Revises: 
+Create Date: 2023-10-23 00:00:00.000000
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+# revision identifiers, used by Alembic.
+revision = '1a39b3495612'
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.create_table(
+        'todos',
+        sa.Column('id', sa.Integer(), nullable=False),
+        sa.Column('title', sa.String(), nullable=True),
+        sa.Column('description', sa.String(), nullable=True),
+        sa.Column('completed', sa.Boolean(), nullable=True),
+        sa.Column('created_at', sa.DateTime(timezone=True), server_default=sa.text('(CURRENT_TIMESTAMP)'), nullable=True),
+        sa.Column('updated_at', sa.DateTime(timezone=True), 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():
+    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')

requirements.txt

@@ -0,0 +1,7 @@
+fastapi==0.104.1
+uvicorn==0.23.2
+sqlalchemy==2.0.22
+pydantic==2.4.2
+alembic==1.12.0
+python-multipart==0.0.6
+ruff==0.1.1