Create Todo application with FastAPI and SQLite

README.md

@@ -1,3 +1,110 @@
-# FastAPI Application
+# Todo Application API
 
-This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform.
+This is a FastAPI-based Todo Application API that allows you to manage todo items. It's built with FastAPI and SQLite for data persistence.
+
+## Features
+
+- Create, read, update, and delete todo items
+- Filter todos by completion status
+- Health check endpoint
+- Swagger/OpenAPI documentation
+- SQLite database with Alembic migrations
+
+## Tech Stack
+
+- **FastAPI**: Modern, fast web framework for building APIs
+- **SQLAlchemy**: SQL toolkit and Object-Relational Mapping
+- **Alembic**: Database migration tool
+- **SQLite**: Lightweight disk-based database
+- **Pydantic**: Data validation and settings management
+- **Uvicorn**: ASGI server for FastAPI
+
+## Setup
+
+1. Clone the repository:
+   ```
+   git clone [your-repository-url]
+   cd todoapplication-omxawp
+   ```
+
+2. Install dependencies:
+   ```
+   pip install -r requirements.txt
+   ```
+
+3. Run the application:
+   ```
+   uvicorn main:app --reload
+   ```
+
+4. Access the API:
+   - API: http://127.0.0.1:8000/
+   - Swagger docs: http://127.0.0.1:8000/docs
+   - ReDoc: http://127.0.0.1:8000/redoc
+
+## API Endpoints
+
+### Health Check
+- `GET /health` - Check if the API is running
+
+### Todo Operations
+- `POST /api/todos/` - Create a new todo
+- `GET /api/todos/` - List all todos (with optional filters)
+- `GET /api/todos/{todo_id}` - Get a specific todo
+- `PUT /api/todos/{todo_id}` - Update a todo
+- `DELETE /api/todos/{todo_id}` - Delete a todo
+
+## Example API Usage
+
+### Create a Todo Item
+```bash
+curl -X 'POST' \
+  'http://127.0.0.1:8000/api/todos/' \
+  -H 'Content-Type: application/json' \
+  -d '{
+  "title": "Buy groceries",
+  "description": "Milk, eggs, bread",
+  "completed": false
+}'
+```
+
+### Get All Todos
+```bash
+curl -X 'GET' 'http://127.0.0.1:8000/api/todos/'
+```
+
+### Get a Specific Todo
+```bash
+curl -X 'GET' 'http://127.0.0.1:8000/api/todos/1'
+```
+
+### Update a Todo
+```bash
+curl -X 'PUT' \
+  'http://127.0.0.1:8000/api/todos/1' \
+  -H 'Content-Type: application/json' \
+  -d '{
+  "completed": true
+}'
+```
+
+### Delete a Todo
+```bash
+curl -X 'DELETE' 'http://127.0.0.1:8000/api/todos/1'
+```
+
+## Database
+
+The application uses SQLite with the database file stored at `/app/storage/db/db.sqlite`.
+
+## Migrations
+
+Migrations are handled with Alembic:
+
+```bash
+# Apply migrations
+alembic upgrade head
+
+# Create a new migration
+alembic revision --autogenerate -m "Description of changes"
+```

alembic.ini

@@ -0,0 +1,106 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = migrations
+
+# 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
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# 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
+# 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 for new projects.
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+# SQLite URL - using absolute path
+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/endpoints/health.py

@@ -0,0 +1,10 @@
+from fastapi import APIRouter
+
+router = APIRouter()
+
+@router.get("/health", summary="Health check endpoint")
+async def health_check():
+    """
+    Health check endpoint that returns a 200 OK status indicating the application is running.
+    """
+    return {"status": "ok"}

app/api/endpoints/todos.py

@@ -0,0 +1,84 @@
+from typing import List, Optional
+from fastapi import APIRouter, Depends, HTTPException, status
+from sqlalchemy.orm import Session
+
+from app.db.session import get_db
+from app.models.todo import Todo as TodoModel
+from app.schemas.todo import Todo, TodoCreate, TodoUpdate
+
+router = APIRouter()
+
+
+@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.
+    """
+    db_todo = TodoModel(**todo.model_dump())
+    db.add(db_todo)
+    db.commit()
+    db.refresh(db_todo)
+    return db_todo
+
+
+@router.get("/", response_model=List[Todo])
+def read_todos(
+    skip: int = 0, 
+    limit: int = 100, 
+    completed: Optional[bool] = None,
+    db: Session = Depends(get_db)
+):
+    """
+    Retrieve todos with optional filtering by completed status.
+    """
+    query = db.query(TodoModel)
+    
+    if completed is not None:
+        query = query.filter(TodoModel.completed == completed)
+    
+    todos = query.offset(skip).limit(limit).all()
+    return todos
+
+
+@router.get("/{todo_id}", response_model=Todo)
+def read_todo(todo_id: int, db: Session = Depends(get_db)):
+    """
+    Get a specific todo by ID.
+    """
+    db_todo = db.query(TodoModel).filter(TodoModel.id == todo_id).first()
+    if db_todo is None:
+        raise HTTPException(status_code=404, detail="Todo not found")
+    return db_todo
+
+
+@router.put("/{todo_id}", response_model=Todo)
+def update_todo(todo_id: int, todo: TodoUpdate, db: Session = Depends(get_db)):
+    """
+    Update a todo item.
+    """
+    db_todo = db.query(TodoModel).filter(TodoModel.id == todo_id).first()
+    if db_todo is None:
+        raise HTTPException(status_code=404, detail="Todo not found")
+    
+    update_data = todo.model_dump(exclude_unset=True)
+    for key, value in update_data.items():
+        setattr(db_todo, key, value)
+    
+    db.add(db_todo)
+    db.commit()
+    db.refresh(db_todo)
+    return db_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 todo item.
+    """
+    db_todo = db.query(TodoModel).filter(TodoModel.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

app/core/config.py

@@ -0,0 +1,19 @@
+from pathlib import Path
+from pydantic_settings import BaseSettings
+
+class Settings(BaseSettings):
+    # Project settings
+    PROJECT_NAME: str = "Todo Application API"
+    PROJECT_DESCRIPTION: str = "A simple Todo API built with FastAPI and SQLite"
+    PROJECT_VERSION: str = "0.1.0"
+    
+    # Database settings
+    DB_DIR: Path = Path("/app") / "storage" / "db"
+    DB_FILE: str = "db.sqlite"
+    SQLALCHEMY_DATABASE_URL: str = f"sqlite:///{DB_DIR}/{DB_FILE}"
+    
+    class Config:
+        env_file = ".env"
+        case_sensitive = True
+
+settings = Settings()

app/db/session.py

@@ -0,0 +1,28 @@
+from sqlalchemy import create_engine
+from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.orm import sessionmaker
+
+from app.core.config import settings
+
+# Ensure the DB directory exists
+settings.DB_DIR.mkdir(parents=True, exist_ok=True)
+
+# Create engine
+engine = create_engine(
+    settings.SQLALCHEMY_DATABASE_URL,
+    connect_args={"check_same_thread": False}
+)
+
+# Create session factory
+SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
+
+# Create base class for models
+Base = declarative_base()
+
+# Dependency to get DB session
+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,17 @@
+from sqlalchemy import Column, Integer, String, Boolean, DateTime
+from sqlalchemy.sql import func
+
+from app.db.session import Base
+
+class Todo(Base):
+    """
+    Todo model to store tasks in the database.
+    """
+    __tablename__ = "todos"
+
+    id = Column(Integer, primary_key=True, index=True)
+    title = Column(String, index=True, nullable=False)
+    description = Column(String, nullable=True)
+    completed = Column(Boolean, default=False)
+    created_at = Column(DateTime, server_default=func.now())
+    updated_at = Column(DateTime, server_default=func.now(), onupdate=func.now())

app/schemas/__init__.py

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

app/schemas/todo.py

@@ -0,0 +1,33 @@
+from datetime import datetime
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+class TodoBase(BaseModel):
+    """Base schema for Todo data."""
+    title: str = Field(..., min_length=1, max_length=100, description="Title of the todo item")
+    description: Optional[str] = Field(None, description="Description of the todo item")
+    completed: bool = Field(False, description="Whether the todo item is completed")
+
+class TodoCreate(TodoBase):
+    """Schema for creating a new Todo."""
+    pass
+
+class TodoUpdate(BaseModel):
+    """Schema for updating an existing Todo."""
+    title: Optional[str] = Field(None, min_length=1, max_length=100, description="Title of the todo item")
+    description: Optional[str] = Field(None, description="Description of the todo item")
+    completed: Optional[bool] = Field(None, description="Whether the todo item is completed")
+
+class TodoInDB(TodoBase):
+    """Schema for Todo in the database."""
+    id: int
+    created_at: datetime
+    updated_at: datetime
+
+    class Config:
+        from_attributes = True
+
+class Todo(TodoInDB):
+    """Schema for Todo response."""
+    pass

main.py

@@ -0,0 +1,17 @@
+import uvicorn
+from fastapi import FastAPI
+from app.api.endpoints import todos, health
+from app.core.config import settings
+
+app = FastAPI(
+    title=settings.PROJECT_NAME,
+    description=settings.PROJECT_DESCRIPTION,
+    version=settings.PROJECT_VERSION,
+)
+
+# Include routers
+app.include_router(health.router, tags=["health"])
+app.include_router(todos.router, prefix="/api/todos", tags=["todos"])
+
+if __name__ == "__main__":
+    uvicorn.run("main:app", host="0.0.0.0", port=8000, reload=True)

migrations/env.py

@@ -0,0 +1,80 @@
+from logging.config import fileConfig
+
+from sqlalchemy import engine_from_config
+from sqlalchemy import pool
+
+from alembic import context
+from app.db.session import Base
+
+# 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():
+    """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/2024_05_11_initial_migration.py

@@ -0,0 +1,40 @@
+"""Initial migration
+
+Revision ID: 2024_05_11_initial
+Revises: 
+Create Date: 2024-05-11
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '2024_05_11_initial'
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # Create todos table
+    op.create_table(
+        'todos',
+        sa.Column('id', sa.Integer(), nullable=False),
+        sa.Column('title', sa.String(), nullable=False),
+        sa.Column('description', sa.String(), nullable=True),
+        sa.Column('completed', sa.Boolean(), nullable=True, default=False),
+        sa.Column('created_at', sa.DateTime(), server_default=sa.text('(CURRENT_TIMESTAMP)'), nullable=True),
+        sa.Column('updated_at', sa.DateTime(), server_default=sa.text('(CURRENT_TIMESTAMP)'), nullable=True),
+        sa.PrimaryKeyConstraint('id')
+    )
+    # Create index on title column
+    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():
+    # Drop todos table and indexes
+    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.100.0,<0.101.0
+uvicorn>=0.23.0,<0.24.0
+sqlalchemy>=2.0.19,<2.1.0
+pydantic>=2.1.1,<2.2.0
+alembic>=1.11.1,<1.12.0
+ruff>=0.0.278,<0.1.0
+python-dotenv>=1.0.0,<1.1.0