Create a simple Todo app with FastAPI and SQLite

README.md

@@ -1,3 +1,95 @@
-# FastAPI Application
+# Simple Todo App
 
-This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform.
+A simple Todo application API built with FastAPI and SQLite.
+
+## Features
+
+- Create, read, update, and delete Todo items
+- Automatically track creation and update timestamps
+- Health check endpoint
+- Database migrations with Alembic
+- API documentation with Swagger UI and ReDoc
+
+## Installation
+
+1. Clone the repository:
+
+```bash
+git clone <repository-url>
+cd simpletodoapp-cstnbs
+```
+
+2. Install dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+3. Run database migrations:
+
+```bash
+alembic upgrade head
+```
+
+## Running the application
+
+Start the application with Uvicorn:
+
+```bash
+uvicorn main:app --reload
+```
+
+The API will be available at http://localhost:8000
+
+## API Documentation
+
+Once the application is running, you can access:
+
+- Swagger UI: http://localhost:8000/docs
+- ReDoc: http://localhost:8000/redoc
+
+## API Endpoints
+
+### Todo Endpoints
+
+- `GET /todos`: Get all todo items
+- `POST /todos`: Create a new todo item
+- `GET /todos/{todo_id}`: Get a specific todo item
+- `PUT /todos/{todo_id}`: Update a specific todo item
+- `DELETE /todos/{todo_id}`: Delete a specific todo item
+
+### Health Check
+
+- `GET /health`: Check the health status of the application
+
+## Project Structure
+
+```
+simpletodoapp-cstnbs/
+├── app/
+│   ├── api/
+│   │   └── routes.py          # API route definitions
+│   ├── core/
+│   │   └── config.py          # Application configuration
+│   ├── db/
+│   │   └── database.py        # Database connection setup
+│   ├── models/
+│   │   └── todo.py            # SQLAlchemy models
+│   ├── schemas/
+│   │   └── todo.py            # Pydantic schemas for API
+│   └── storage/
+│       └── db/                # SQLite database storage
+├── migrations/                # Alembic migrations
+│   ├── versions/
+│   │   └── *.py               # Migration scripts
+│   ├── env.py                 # Alembic environment
+│   └── script.py.mako         # Migration script template
+├── alembic.ini                # Alembic configuration
+├── main.py                    # Application entry point
+├── requirements.txt           # Project dependencies
+└── README.md                  # This file
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.

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 example
+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
+
+# 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/__init__.py

@@ -0,0 +1 @@
+# This file intentionally left empty to make the directory a package

app/api/__init__.py

@@ -0,0 +1 @@
+# This file intentionally left empty to make the directory a package

app/api/routes.py

@@ -0,0 +1,97 @@
+from typing import List
+
+from fastapi import APIRouter, Depends, HTTPException, status
+from sqlalchemy.orm import Session
+
+from app.db.database import get_db
+from app.models.todo import Todo
+from app.schemas.todo import TodoCreate, TodoResponse, TodoUpdate
+
+# Create routers
+todo_router = APIRouter(prefix="/todos", tags=["todos"])
+health_router = APIRouter(tags=["health"])
+
+
+@todo_router.post("/", response_model=TodoResponse, status_code=status.HTTP_201_CREATED)
+def create_todo(todo: TodoCreate, db: Session = Depends(get_db)):
+    """
+    Create a new todo item.
+    """
+    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
+
+
+@todo_router.get("/", response_model=List[TodoResponse])
+def read_todos(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)):
+    """
+    Retrieve all todo items with pagination.
+    """
+    todos = db.query(Todo).offset(skip).limit(limit).all()
+    return todos
+
+
+@todo_router.get("/{todo_id}", response_model=TodoResponse)
+def read_todo(todo_id: int, db: Session = Depends(get_db)):
+    """
+    Retrieve a specific todo item by ID.
+    """
+    db_todo = db.query(Todo).filter(Todo.id == todo_id).first()
+    if db_todo is None:
+        raise HTTPException(status_code=404, detail="Todo not found")
+    return db_todo
+
+
+@todo_router.put("/{todo_id}", response_model=TodoResponse)
+def update_todo(todo_id: int, todo: TodoUpdate, db: Session = Depends(get_db)):
+    """
+    Update a specific todo item.
+    """
+    db_todo = db.query(Todo).filter(Todo.id == todo_id).first()
+    if db_todo is None:
+        raise HTTPException(status_code=404, detail="Todo not found")
+    
+    # Update fields if provided
+    if todo.title is not None:
+        db_todo.title = todo.title
+    if todo.description is not None:
+        db_todo.description = todo.description
+    if todo.completed is not None:
+        db_todo.completed = todo.completed
+    
+    db.commit()
+    db.refresh(db_todo)
+    return db_todo
+
+
+@todo_router.delete(
+    "/{todo_id}", 
+    status_code=status.HTTP_204_NO_CONTENT, 
+    response_model=None
+)
+def delete_todo(todo_id: int, db: Session = Depends(get_db)):
+    """
+    Delete a specific todo item.
+    """
+    db_todo = db.query(Todo).filter(Todo.id == todo_id).first()
+    if db_todo is None:
+        raise HTTPException(status_code=404, detail="Todo not found")
+    
+    db.delete(db_todo)
+    db.commit()
+    return None
+
+
+# Health endpoint
+@health_router.get("/health", status_code=status.HTTP_200_OK)
+def health_check():
+    """
+    Health check endpoint for monitoring the application status.
+    """
+    return {"status": "ok"}

app/core/__init__.py

@@ -0,0 +1 @@
+# This file intentionally left empty to make the directory a package

app/core/config.py

@@ -0,0 +1,7 @@
+from pathlib import Path
+
+# Database configuration
+DB_DIR = Path("/app") / "storage" / "db"
+DB_DIR.mkdir(parents=True, exist_ok=True)
+
+SQLALCHEMY_DATABASE_URL = f"sqlite:///{DB_DIR}/db.sqlite"

app/db/__init__.py

@@ -0,0 +1 @@
+# This file intentionally left empty to make the directory a package

app/db/database.py

@@ -0,0 +1,31 @@
+from sqlalchemy import create_engine
+from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.orm import sessionmaker
+
+from app.core.config import SQLALCHEMY_DATABASE_URL
+
+# Create SQLAlchemy engine
+engine = create_engine(
+    SQLALCHEMY_DATABASE_URL,
+    connect_args={"check_same_thread": False}  # Needed for SQLite
+)
+
+# Create SessionLocal class
+SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
+
+# Create a Base class for declarative models
+Base = declarative_base()
+
+
+# Dependency to get the database session
+def get_db():
+    db = SessionLocal()
+    try:
+        yield db
+    finally:
+        db.close()
+
+
+# Function to create database tables
+def create_tables():
+    Base.metadata.create_all(bind=engine)

app/models/__init__.py

@@ -0,0 +1 @@
+# This file intentionally left empty to make the directory a package

app/models/todo.py

@@ -0,0 +1,15 @@
+from sqlalchemy import Boolean, Column, DateTime, Integer, String
+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 @@
+# This file intentionally left empty to make the directory a package

app/schemas/todo.py

@@ -0,0 +1,29 @@
+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 TodoResponse(TodoBase):
+    id: int
+    created_at: datetime
+    updated_at: Optional[datetime] = None
+
+    class Config:
+        from_attributes = True

main.py

@@ -0,0 +1,23 @@
+from fastapi import FastAPI
+
+from app.api.routes import health_router, todo_router
+from app.db.database import create_tables
+
+app = FastAPI(
+    title="TodoApp",
+    description="A simple ToDo application API",
+    version="1.0.0"
+)
+
+# Include routers
+app.include_router(todo_router)
+app.include_router(health_router)
+
+# Create tables on startup
+@app.on_event("startup")
+async def startup_event():
+    create_tables()
+
+if __name__ == "__main__":
+    import uvicorn
+    uvicorn.run("main:app", host="0.0.0.0", port=8000, reload=True)

migrations/README

@@ -0,0 +1 @@
+Generic single-database configuration with SQLite.

migrations/env.py

@@ -0,0 +1,80 @@
+from logging.config import fileConfig
+
+from alembic import context
+from sqlalchemy import engine_from_config, pool
+
+from app.db.database import Base
+from app.models.todo import Todo  # noqa: F401
+
+# 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
+# target_metadata = None
+
+# 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:
+        is_sqlite = connection.dialect.name == 'sqlite'
+        context.configure(
+            connection=connection,
+            target_metadata=target_metadata,
+            render_as_batch=is_sqlite  # Key configuration for SQLite
+        )
+
+        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/e78c46de0b52_create_todos_table.py

@@ -0,0 +1,40 @@
+"""create todos table
+
+Revision ID: e78c46de0b52
+Revises: 
+Create Date: 2023-10-01 00:00:00.000000
+
+"""
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = 'e78c46de0b52'
+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, default=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), 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.103.1
+uvicorn==0.23.2
+sqlalchemy==2.0.21
+alembic==1.12.0
+pydantic==2.4.2
+python-dotenv==1.0.0
+ruff==0.0.291