Create simple todo app with FastAPI and SQLite

README.md

@@ -1,3 +1,121 @@
-# FastAPI Application
+# Simple Todo App API
 
-This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform.
+A simple Todo API built with FastAPI and SQLite.
+
+## Features
+
+- Create, Read, Update, Delete (CRUD) operations for todo items
+- Filter todos by completion status
+- RESTful API with FastAPI
+- SQLite database with SQLAlchemy ORM
+- Alembic for database migrations
+- API documentation with Swagger UI and ReDoc
+
+## Project Structure
+
+```
+.
+├── alembic/               # Database migration files
+│   ├── versions/          # Migration versions
+│   ├── env.py             # Alembic environment configuration
+│   └── script.py.mako     # Migration script template
+├── app/                   # Application code
+│   ├── api/               # API endpoints
+│   │   └── v1/            # API version 1
+│   │       └── todos.py   # Todo endpoints
+│   ├── core/              # Core application code
+│   │   └── config.py      # Application configuration
+│   ├── crud/              # CRUD operations
+│   │   ├── base.py        # Base CRUD operations
+│   │   └── todo.py        # Todo specific CRUD operations
+│   ├── db/                # Database setup
+│   │   ├── base.py        # Import all models
+│   │   ├── base_class.py  # Base class for models
+│   │   └── session.py     # Database session
+│   ├── models/            # SQLAlchemy models
+│   │   └── todo.py        # Todo model
+│   └── schemas/           # Pydantic schemas
+│       └── todo.py        # Todo schemas
+├── alembic.ini            # Alembic configuration
+├── main.py                # Application entry point
+└── requirements.txt       # Python dependencies
+```
+
+## Getting Started
+
+### Prerequisites
+
+- Python 3.7 or higher
+
+### Installation
+
+1. Clone the repository
+
+2. Install the dependencies:
+   ```
+   pip install -r requirements.txt
+   ```
+
+3. Apply the database migrations:
+   ```
+   alembic upgrade head
+   ```
+
+4. Run the application:
+   ```
+   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
+
+### Todos
+
+- `GET /api/v1/todos` - Get all todos
+- `GET /api/v1/todos?is_completed=true|false` - Get todos filtered by completion status
+- `GET /api/v1/todos/{id}` - Get a todo by id
+- `POST /api/v1/todos` - Create a new todo
+- `PUT /api/v1/todos/{id}` - Update a todo
+- `DELETE /api/v1/todos/{id}` - Delete a todo
+
+### Health Check
+
+- `GET /health` - Check if the API is running
+
+## Data Models
+
+### Todo
+
+- `id`: Integer (Primary Key)
+- `title`: String (Required)
+- `description`: Text (Optional)
+- `is_completed`: Boolean (Default: false)
+- `created_at`: DateTime (Auto-generated)
+- `updated_at`: DateTime (Auto-updated)
+
+## Example
+
+### Create a Todo
+
+```bash
+curl -X 'POST' \
+  'http://localhost:8000/api/v1/todos/' \
+  -H 'Content-Type: application/json' \
+  -d '{
+  "title": "Learn FastAPI",
+  "description": "Build a simple todo app using FastAPI",
+  "is_completed": false
+}'
+```
+
+### Get All Todos
+
+```bash
+curl -X 'GET' 'http://localhost:8000/api/v1/todos/'
+```

alembic.ini

@@ -0,0 +1,85 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = alembic
+
+# 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 alembic/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path
+# version_locations = %(here)s/bar %(here)s/bat alembic/versions
+
+# 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
+
+# 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,76 @@
+from logging.config import fileConfig
+
+from sqlalchemy import engine_from_config
+from sqlalchemy import pool
+
+from alembic import context
+
+# 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
+from app.db.base import Base  # noqa
+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()

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

alembic/versions/0001_create_todo_table.py

@@ -0,0 +1,35 @@
+"""create todo table
+
+Revision ID: 0001
+Revises: 
+Create Date: 2023-11-04
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '0001'
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.create_table(
+        'todo',
+        sa.Column('id', sa.Integer(), nullable=False),
+        sa.Column('title', sa.String(length=100), nullable=False),
+        sa.Column('description', sa.Text(), nullable=True),
+        sa.Column('is_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_todo_id'), 'todo', ['id'], unique=False)
+
+
+def downgrade():
+    op.drop_index(op.f('ix_todo_id'), table_name='todo')
+    op.drop_table('todo')

app/api/routes.py

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

app/api/v1/todos.py

@@ -0,0 +1,71 @@
+from typing import Any, List, Optional
+
+from fastapi import APIRouter, Depends, HTTPException, Query
+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,
+    is_completed: Optional[bool] = None,
+) -> Any:
+    """Retrieve todos."""
+    if is_completed is not None:
+        todos = crud.todo.get_multi_by_completed(
+            db, is_completed=is_completed, skip=skip, limit=limit
+        )
+    else:
+        todos = crud.todo.get_multi(db, skip=skip, limit=limit)
+    return todos
+
+
+@router.post("/", response_model=schemas.Todo)
+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("/{id}", response_model=schemas.Todo)
+def read_todo(*, db: Session = Depends(get_db), id: int) -> Any:
+    """Get todo by ID."""
+    todo = crud.todo.get(db=db, id=id)
+    if not todo:
+        raise HTTPException(status_code=404, detail="Todo not found")
+    return todo
+
+
+@router.put("/{id}", response_model=schemas.Todo)
+def update_todo(
+    *,
+    db: Session = Depends(get_db),
+    id: int,
+    todo_in: schemas.TodoUpdate,
+) -> Any:
+    """Update a todo."""
+    todo = crud.todo.get(db=db, id=id)
+    if not todo:
+        raise HTTPException(status_code=404, detail="Todo not found")
+    todo = crud.todo.update(db=db, db_obj=todo, obj_in=todo_in)
+    return todo
+
+
+@router.delete("/{id}", response_model=schemas.Todo)
+def delete_todo(*, db: Session = Depends(get_db), id: int) -> Any:
+    """Delete a todo."""
+    todo = crud.todo.get(db=db, id=id)
+    if not todo:
+        raise HTTPException(status_code=404, detail="Todo not found")
+    todo = crud.todo.remove(db=db, id=id)
+    return todo

app/core/config.py

@@ -0,0 +1,20 @@
+from pathlib import Path
+from pydantic import BaseSettings
+
+
+class Settings(BaseSettings):
+    API_V1_STR: str = "/api/v1"
+    PROJECT_NAME: str = "Simple Todo App"
+
+    # Database settings
+    DB_DIR = Path("/app") / "storage" / "db"
+    DB_DIR.mkdir(parents=True, exist_ok=True)
+
+    SQLALCHEMY_DATABASE_URL: str = f"sqlite:///{DB_DIR}/db.sqlite"
+
+    class Config:
+        case_sensitive = True
+        env_file = ".env"
+
+
+settings = Settings()

app/crud/__init__.py

@@ -0,0 +1 @@
+from app.crud.todo import todo  # noqa

app/crud/base.py

@@ -0,0 +1,68 @@
+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_class import Base
+
+ModelType = TypeVar("ModelType", bound=Base)
+CreateSchemaType = TypeVar("CreateSchemaType", bound=BaseModel)
+UpdateSchemaType = TypeVar("UpdateSchemaType", bound=BaseModel)
+
+
+class CRUDBase(Generic[ModelType, CreateSchemaType, UpdateSchemaType]):
+    def __init__(self, model: Type[ModelType]):
+        """CRUD object with default methods to Create, Read, Update, Delete (CRUD).
+
+        Args:
+            model: A SQLAlchemy model class
+        """
+        self.model = model
+
+    def get(self, db: Session, id: int) -> Optional[ModelType]:
+        """Get a record 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 records."""
+        return db.query(self.model).offset(skip).limit(limit).all()
+
+    def create(self, db: Session, *, obj_in: CreateSchemaType) -> ModelType:
+        """Create a new record."""
+        obj_in_data = jsonable_encoder(obj_in)
+        db_obj = self.model(**obj_in_data)  # type: ignore
+        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 a record."""
+        obj_data = jsonable_encoder(db_obj)
+        if isinstance(obj_in, dict):
+            update_data = obj_in
+        else:
+            update_data = obj_in.dict(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 a record."""
+        obj = db.query(self.model).get(id)
+        db.delete(obj)
+        db.commit()
+        return obj

app/crud/todo.py

@@ -0,0 +1,25 @@
+from typing import List, Optional
+
+from sqlalchemy.orm import Session
+
+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."""
+    def get_multi_by_completed(
+        self, db: Session, *, is_completed: bool, skip: int = 0, limit: int = 100
+    ) -> List[Todo]:
+        """Get todos by completion status."""
+        return (
+            db.query(self.model)
+            .filter(Todo.is_completed == is_completed)
+            .offset(skip)
+            .limit(limit)
+            .all()
+        )
+
+
+todo = CRUDTodo(Todo)

app/db/base.py

@@ -0,0 +1,5 @@
+# Import all the models, so that Base has them before being
+# imported by Alembic
+
+from app.db.base_class import Base  # noqa
+from app.models.todo import Todo  # noqa

app/db/base_class.py

@@ -0,0 +1,14 @@
+from typing import Any
+
+from sqlalchemy.ext.declarative import as_declarative, declared_attr
+
+
+@as_declarative()
+class Base:
+    id: Any
+    __name__: str
+
+    # Generate __tablename__ automatically based on class name
+    @declared_attr
+    def __tablename__(cls) -> str:
+        return cls.__name__.lower()

app/db/session.py

@@ -0,0 +1,19 @@
+from sqlalchemy import create_engine
+from sqlalchemy.orm import sessionmaker
+from app.core.config import settings
+
+engine = create_engine(
+    settings.SQLALCHEMY_DATABASE_URL,
+    connect_args={"check_same_thread": False},
+)
+
+SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
+
+
+def get_db():
+    """Dependency for getting DB session"""
+    db = SessionLocal()
+    try:
+        yield db
+    finally:
+        db.close()

app/models/__init__.py

@@ -0,0 +1 @@
+from app.models.todo import Todo  # noqa

app/models/todo.py

@@ -0,0 +1,13 @@
+from sqlalchemy import Boolean, Column, Integer, String, Text, DateTime
+from sqlalchemy.sql import func
+from app.db.base_class import Base
+
+
+class Todo(Base):
+    """Todo model."""
+    id = Column(Integer, primary_key=True, index=True)
+    title = Column(String(100), nullable=False)
+    description = Column(Text, nullable=True)
+    is_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 @@
+from app.schemas.todo import Todo, TodoCreate, TodoUpdate  # noqa

app/schemas/todo.py

@@ -0,0 +1,37 @@
+from datetime import datetime
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+# Shared properties
+class TodoBase(BaseModel):
+    title: str
+    description: Optional[str] = None
+    is_completed: bool = False
+
+
+# Properties to receive on todo creation
+class TodoCreate(TodoBase):
+    pass
+
+
+# Properties to receive on todo update
+class TodoUpdate(TodoBase):
+    title: Optional[str] = None
+    is_completed: Optional[bool] = None
+
+
+# Properties shared by models stored in DB
+class TodoInDBBase(TodoBase):
+    id: int
+    created_at: datetime
+    updated_at: Optional[datetime] = None
+
+    class Config:
+        orm_mode = True
+
+
+# Properties to return to client
+class Todo(TodoInDBBase):
+    pass

main.py

@@ -0,0 +1,29 @@
+import uvicorn
+from fastapi import FastAPI
+from app.api.routes import router as api_router
+from app.core.config import settings
+
+app = FastAPI(
+    title=settings.PROJECT_NAME,
+    description="Simple Todo App API",
+    version="0.1.0",
+    docs_url="/docs",
+    redoc_url="/redoc",
+)
+
+
+@app.get("/health", tags=["health"])
+async def health_check():
+    """Health check endpoint"""
+    return {"status": "ok", "message": "Todo API is running"}
+
+
+app.include_router(api_router, prefix=settings.API_V1_STR)
+
+if __name__ == "__main__":
+    uvicorn.run(
+        "main:app",
+        host="0.0.0.0",
+        port=8000,
+        reload=True,
+    )

pyproject.toml

@@ -0,0 +1,8 @@
+[tool.ruff]
+line-length = 88
+target-version = "py37"
+select = ["E", "F", "I", "N", "W", "B"]
+ignore = []
+
+[tool.ruff.isort]
+known-third-party = ["fastapi", "pydantic", "sqlalchemy", "alembic"]

requirements.txt

@@ -0,0 +1,7 @@
+fastapi>=0.95.0,<0.96.0
+uvicorn>=0.21.1,<0.22.0
+pydantic>=1.10.7,<1.11.0
+sqlalchemy>=2.0.9,<2.1.0
+alembic>=1.10.3,<1.11.0
+python-dotenv>=1.0.0,<1.1.0
+ruff>=0.0.262,<0.1.0