Create complete FastAPI Todo application

- Set up FastAPI application with CORS support
- Created SQLite database configuration with absolute paths
- Implemented Todo model with SQLAlchemy
- Added full CRUD operations for todos
- Created API endpoints with proper error handling
- Set up Alembic for database migrations
- Added health check and base URL endpoints
- Updated README with comprehensive documentation
- Configured project structure following best practices

Features:
- Complete Todo CRUD API
- SQLite database with proper path configuration
- Database migrations with Alembic
- API documentation at /docs and /redoc
- Health check endpoint at /health
- CORS enabled for all origins
- Proper error handling and validation

README.md

@@ -1,3 +1,147 @@
-# FastAPI Application
+# Todo API
 
-This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform.
+A simple Todo API built with FastAPI and SQLite. This application provides a RESTful API for managing todo items with full CRUD operations.
+
+## Features
+
+- Create, read, update, and delete todo items
+- SQLite database with SQLAlchemy ORM
+- Database migrations with Alembic
+- Automatic API documentation with FastAPI
+- CORS support for cross-origin requests
+- Health check endpoint
+- Proper error handling and validation
+
+## Project Structure
+
+```
+todoapp-h5yaal/
+├── main.py                    # FastAPI application entry point
+├── requirements.txt           # Python dependencies
+├── alembic.ini               # Alembic configuration
+├── alembic/                  # Database migrations
+│   ├── env.py
+│   └── versions/
+│       └── 001_initial_migration.py
+└── app/
+    ├── __init__.py
+    ├── api/
+    │   ├── __init__.py
+    │   └── todos.py          # Todo API endpoints
+    ├── db/
+    │   ├── __init__.py
+    │   ├── base.py           # SQLAlchemy Base
+    │   ├── session.py        # Database session configuration
+    │   └── crud.py           # Database operations
+    └── models/
+        ├── __init__.py
+        ├── todo.py           # Todo SQLAlchemy model
+        └── schemas.py        # Pydantic schemas
+```
+
+## Installation
+
+1. Install dependencies:
+```bash
+pip install -r requirements.txt
+```
+
+2. Run database migrations:
+```bash
+alembic upgrade head
+```
+
+## Running the Application
+
+Start the development server:
+```bash
+uvicorn main:app --reload --host 0.0.0.0 --port 8000
+```
+
+The application will be available at:
+- API: http://localhost:8000
+- Documentation: http://localhost:8000/docs
+- Alternative docs: http://localhost:8000/redoc
+- OpenAPI JSON: http://localhost:8000/openapi.json
+- Health check: http://localhost:8000/health
+
+## API Endpoints
+
+### Base Endpoints
+- `GET /` - API information and links
+- `GET /health` - Health check endpoint
+
+### Todo Endpoints
+- `GET /api/v1/todos` - Get all todos (with pagination)
+- `GET /api/v1/todos/{todo_id}` - Get a specific todo
+- `POST /api/v1/todos` - Create a new todo
+- `PUT /api/v1/todos/{todo_id}` - Update a todo
+- `DELETE /api/v1/todos/{todo_id}` - Delete a todo
+
+### Example API Usage
+
+Create a todo:
+```bash
+curl -X POST "http://localhost:8000/api/v1/todos" \
+  -H "Content-Type: application/json" \
+  -d '{"title": "Buy groceries", "description": "Milk, bread, eggs", "completed": false}'
+```
+
+Get all todos:
+```bash
+curl "http://localhost:8000/api/v1/todos"
+```
+
+Update a todo:
+```bash
+curl -X PUT "http://localhost:8000/api/v1/todos/1" \
+  -H "Content-Type: application/json" \
+  -d '{"completed": true}'
+```
+
+## Database
+
+The application uses SQLite database stored at `/app/storage/db/db.sqlite`. The database schema is managed through Alembic migrations.
+
+### Database Schema
+
+**Todos Table:**
+- `id` (Integer, Primary Key)
+- `title` (String, Required)
+- `description` (Text, Optional)
+- `completed` (Boolean, Default: False)
+- `created_at` (DateTime)
+- `updated_at` (DateTime)
+
+## Development
+
+### Running Migrations
+
+Create a new migration:
+```bash
+alembic revision --autogenerate -m "Description of changes"
+```
+
+Apply migrations:
+```bash
+alembic upgrade head
+```
+
+### Code Quality
+
+The project uses Ruff for linting and code formatting:
+```bash
+ruff check . --fix
+```
+
+## Environment Variables
+
+This application doesn't currently require any environment variables, but you can extend it by adding configuration for:
+- Database URL
+- CORS origins
+- Logging level
+- API keys (if authentication is added)
+
+## License
+
+This project is generated by BackendIM.

alembic.ini

@@ -0,0 +1,98 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = alembic
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(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
+# max_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 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
+
+# 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
+
+# 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

alembic/env.py

@@ -0,0 +1,85 @@
+import sys
+from pathlib import Path
+from logging.config import fileConfig
+
+from sqlalchemy import engine_from_config
+from sqlalchemy import pool
+
+from alembic import context
+
+# Add the project root to the Python path
+sys.path.append(str(Path(__file__).parent.parent))
+
+# Import your models here
+from app.db.base import Base
+from app.models.todo import Todo  # Import all models to ensure they're registered
+
+# 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.
+if config.config_file_name is not None:
+    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:
+        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()

alembic/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() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}

alembic/versions/001_initial_migration.py

@@ -0,0 +1,37 @@
+"""Initial migration - create todos table
+
+Revision ID: 001
+Revises: 
+Create Date: 2023-12-07 10:00:00.000000
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+# revision identifiers, used by Alembic.
+revision = '001'
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    # Create todos table
+    op.create_table(
+        'todos',
+        sa.Column('id', sa.Integer(), nullable=False),
+        sa.Column('title', sa.String(length=200), nullable=False),
+        sa.Column('description', sa.Text(), nullable=True),
+        sa.Column('completed', sa.Boolean(), nullable=False, default=False),
+        sa.Column('created_at', sa.DateTime(), nullable=False),
+        sa.Column('updated_at', sa.DateTime(), nullable=False),
+        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')

app/api/todos.py

@@ -0,0 +1,57 @@
+from typing import List
+from fastapi import APIRouter, Depends, HTTPException, status
+from sqlalchemy.orm import Session
+
+from app.db.session import get_db
+from app.db import crud
+from app.models.schemas import TodoCreate, TodoResponse, TodoUpdate
+
+router = APIRouter()
+
+
+@router.get("/todos", response_model=List[TodoResponse])
+def get_todos(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)):
+    """Get all todos with pagination"""
+    todos = crud.get_todos(db, skip=skip, limit=limit)
+    return todos
+
+
+@router.get("/todos/{todo_id}", response_model=TodoResponse)
+def get_todo(todo_id: int, db: Session = Depends(get_db)):
+    """Get a specific todo by ID"""
+    todo = crud.get_todo(db, todo_id=todo_id)
+    if todo is None:
+        raise HTTPException(
+            status_code=status.HTTP_404_NOT_FOUND,
+            detail="Todo not found"
+        )
+    return todo
+
+
+@router.post("/todos", response_model=TodoResponse, status_code=status.HTTP_201_CREATED)
+def create_todo(todo: TodoCreate, db: Session = Depends(get_db)):
+    """Create a new todo"""
+    return crud.create_todo(db=db, todo=todo)
+
+
+@router.put("/todos/{todo_id}", response_model=TodoResponse)
+def update_todo(todo_id: int, todo_update: TodoUpdate, db: Session = Depends(get_db)):
+    """Update an existing todo"""
+    todo = crud.update_todo(db, todo_id=todo_id, todo_update=todo_update)
+    if todo is None:
+        raise HTTPException(
+            status_code=status.HTTP_404_NOT_FOUND,
+            detail="Todo not found"
+        )
+    return todo
+
+
+@router.delete("/todos/{todo_id}", status_code=status.HTTP_204_NO_CONTENT)
+def delete_todo(todo_id: int, db: Session = Depends(get_db)):
+    """Delete a todo"""
+    success = crud.delete_todo(db, todo_id=todo_id)
+    if not success:
+        raise HTTPException(
+            status_code=status.HTTP_404_NOT_FOUND,
+            detail="Todo not found"
+        )

app/db/base.py

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

app/db/crud.py

@@ -0,0 +1,49 @@
+from typing import List, Optional
+from sqlalchemy.orm import Session
+from app.models.todo import Todo
+from app.models.schemas import TodoCreate, TodoUpdate
+
+
+def get_todo(db: Session, todo_id: int) -> Optional[Todo]:
+    """Get a single todo by ID"""
+    return db.query(Todo).filter(Todo.id == todo_id).first()
+
+
+def get_todos(db: Session, skip: int = 0, limit: int = 100) -> List[Todo]:
+    """Get all todos with pagination"""
+    return db.query(Todo).offset(skip).limit(limit).all()
+
+
+def create_todo(db: Session, todo: TodoCreate) -> Todo:
+    """Create a new 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_update: TodoUpdate) -> Optional[Todo]:
+    """Update an existing todo"""
+    db_todo = db.query(Todo).filter(Todo.id == todo_id).first()
+    if db_todo:
+        update_data = todo_update.dict(exclude_unset=True)
+        for field, value in update_data.items():
+            setattr(db_todo, field, value)
+        db.commit()
+        db.refresh(db_todo)
+    return db_todo
+
+
+def delete_todo(db: Session, todo_id: int) -> bool:
+    """Delete a todo"""
+    db_todo = db.query(Todo).filter(Todo.id == todo_id).first()
+    if db_todo:
+        db.delete(db_todo)
+        db.commit()
+        return True
+    return False

app/db/session.py

@@ -0,0 +1,25 @@
+from pathlib import Path
+from sqlalchemy import create_engine
+from sqlalchemy.orm import sessionmaker
+
+# Database configuration using absolute path
+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)
+
+
+def get_db():
+    """Dependency to get database session"""
+    db = SessionLocal()
+    try:
+        yield db
+    finally:
+        db.close()

app/models/schemas.py

@@ -0,0 +1,39 @@
+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: datetime
+
+    class Config:
+        from_attributes = True
+
+
+class HealthResponse(BaseModel):
+    status: str
+    timestamp: datetime
+
+
+class BaseResponse(BaseModel):
+    title: str
+    documentation: str
+    health_endpoint: str

app/models/todo.py

@@ -0,0 +1,14 @@
+from datetime import datetime
+from sqlalchemy import Boolean, Column, DateTime, Integer, String, Text
+from app.db.base import Base
+
+
+class Todo(Base):
+    __tablename__ = "todos"
+
+    id = Column(Integer, primary_key=True, index=True)
+    title = Column(String(200), nullable=False, index=True)
+    description = Column(Text, nullable=True)
+    completed = Column(Boolean, default=False, nullable=False)
+    created_at = Column(DateTime, default=datetime.utcnow, nullable=False)
+    updated_at = Column(DateTime, default=datetime.utcnow, onupdate=datetime.utcnow, nullable=False)

main.py

@@ -0,0 +1,51 @@
+from datetime import datetime
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+
+from app.api.todos import router as todos_router
+from app.models.schemas import HealthResponse, BaseResponse
+from app.db.base import Base
+from app.db.session import engine
+
+# Create database tables
+Base.metadata.create_all(bind=engine)
+
+app = FastAPI(
+    title="Todo API",
+    description="A simple Todo API built with FastAPI and SQLite",
+    version="1.0.0",
+    docs_url="/docs",
+    redoc_url="/redoc",
+    openapi_url="/openapi.json"
+)
+
+# Configure CORS
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=["*"],
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"],
+)
+
+# Include routers
+app.include_router(todos_router, prefix="/api/v1", tags=["todos"])
+
+
+@app.get("/", response_model=BaseResponse)
+def read_root():
+    """Base URL endpoint with project information"""
+    return BaseResponse(
+        title="Todo API",
+        documentation="/docs",
+        health_endpoint="/health"
+    )
+
+
+@app.get("/health", response_model=HealthResponse)
+def health_check():
+    """Health check endpoint"""
+    return HealthResponse(
+        status="healthy",
+        timestamp=datetime.utcnow()
+    )

requirements.txt

@@ -0,0 +1,7 @@
+fastapi==0.104.1
+uvicorn[standard]==0.24.0
+sqlalchemy==2.0.23
+alembic==1.12.1
+ruff==0.1.6
+python-multipart==0.0.6
+pydantic==2.5.0