From d6676511100a79883ab7b973dda1703c156ac359 Mon Sep 17 00:00:00 2001 From: Automated Action Date: Thu, 19 Jun 2025 22:02:18 +0000 Subject: [PATCH] Create simple Todo app with FastAPI and SQLite - Add CRUD operations for todos (create, read, update, delete) - Implement SQLAlchemy models and schemas - Set up Alembic for database migrations - Add health endpoint and CORS configuration - Include comprehensive API documentation - Structure project with proper separation of concerns --- README.md | 70 +++++++++++++++++++++- alembic.ini | 41 +++++++++++++ alembic/env.py | 52 ++++++++++++++++ alembic/script.py.mako | 24 ++++++++ alembic/versions/001_initial_todo_table.py | 35 +++++++++++ app/__init__.py | 0 app/db/__init__.py | 0 app/db/base.py | 3 + app/db/session.py | 23 +++++++ app/models/__init__.py | 3 + app/models/todo.py | 14 +++++ app/routes/__init__.py | 3 + app/routes/todos.py | 57 ++++++++++++++++++ app/schemas/__init__.py | 3 + app/schemas/todo.py | 28 +++++++++ main.py | 39 ++++++++++++ requirements.txt | 6 ++ 17 files changed, 399 insertions(+), 2 deletions(-) create mode 100644 alembic.ini create mode 100644 alembic/env.py create mode 100644 alembic/script.py.mako create mode 100644 alembic/versions/001_initial_todo_table.py create mode 100644 app/__init__.py create mode 100644 app/db/__init__.py create mode 100644 app/db/base.py create mode 100644 app/db/session.py create mode 100644 app/models/__init__.py create mode 100644 app/models/todo.py create mode 100644 app/routes/__init__.py create mode 100644 app/routes/todos.py create mode 100644 app/schemas/__init__.py create mode 100644 app/schemas/todo.py create mode 100644 main.py create mode 100644 requirements.txt diff --git a/README.md b/README.md index e8acfba..b5b53cd 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,69 @@ -# FastAPI Application +# Todo App API -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 + +- CRUD operations for todos (Create, Read, Update, Delete) +- SQLite database with SQLAlchemy ORM +- Database migrations with Alembic +- CORS enabled for all origins +- Health check endpoint +- Interactive API documentation + +## Installation + +1. Install dependencies: +```bash +pip install -r requirements.txt +``` + +2. Run database migrations: +```bash +alembic upgrade head +``` + +3. Start the application: +```bash +uvicorn main:app --reload +``` + +The API will be available at `http://localhost:8000` + +## API Endpoints + +### Base +- `GET /` - API information and links +- `GET /health` - Health check + +### Todos +- `POST /todos/` - Create a new todo +- `GET /todos/` - Get all todos (with pagination) +- `GET /todos/{todo_id}` - Get a specific todo +- `PUT /todos/{todo_id}` - Update a todo +- `DELETE /todos/{todo_id}` - Delete a todo + +## Documentation + +- Interactive API docs: `http://localhost:8000/docs` +- ReDoc documentation: `http://localhost:8000/redoc` +- OpenAPI JSON: `http://localhost:8000/openapi.json` + +## Database + +The application uses SQLite with the database file stored at `/app/storage/db/db.sqlite`. + +## Project Structure + +``` +├── main.py # FastAPI application entry point +├── requirements.txt # Python dependencies +├── alembic.ini # Alembic configuration +├── alembic/ # Database migrations +├── app/ +│ ├── db/ # Database configuration +│ ├── models/ # SQLAlchemy models +│ ├── schemas/ # Pydantic schemas +│ └── routes/ # API routes +└── storage/ # Application storage directory +``` diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..017f263 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,41 @@ +[alembic] +script_location = alembic +prepend_sys_path = . +version_path_separator = os +sqlalchemy.url = sqlite:////app/storage/db/db.sqlite + +[post_write_hooks] + +[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 \ No newline at end of file diff --git a/alembic/env.py b/alembic/env.py new file mode 100644 index 0000000..a7c82e0 --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,52 @@ +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 + +sys.path.append(str(Path(__file__).resolve().parent.parent)) + +from app.db.base import Base + +config = context.config + +if config.config_file_name is not None: + fileConfig(config.config_file_name) + +target_metadata = Base.metadata + + +def run_migrations_offline() -> None: + 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: + 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() \ No newline at end of file diff --git a/alembic/script.py.mako b/alembic/script.py.mako new file mode 100644 index 0000000..37d0cac --- /dev/null +++ b/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"} \ No newline at end of file diff --git a/alembic/versions/001_initial_todo_table.py b/alembic/versions/001_initial_todo_table.py new file mode 100644 index 0000000..8713903 --- /dev/null +++ b/alembic/versions/001_initial_todo_table.py @@ -0,0 +1,35 @@ +"""Initial todo table + +Revision ID: 001 +Revises: +Create Date: 2024-01-01 00: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: + 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=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() -> 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') \ No newline at end of file diff --git a/app/__init__.py b/app/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/db/__init__.py b/app/db/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/db/base.py b/app/db/base.py new file mode 100644 index 0000000..7c2377a --- /dev/null +++ b/app/db/base.py @@ -0,0 +1,3 @@ +from sqlalchemy.ext.declarative import declarative_base + +Base = declarative_base() \ No newline at end of file diff --git a/app/db/session.py b/app/db/session.py new file mode 100644 index 0000000..e77d375 --- /dev/null +++ b/app/db/session.py @@ -0,0 +1,23 @@ +from pathlib import Path +from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker + +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(): + db = SessionLocal() + try: + yield db + finally: + db.close() \ No newline at end of file diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 0000000..a5b88be --- /dev/null +++ b/app/models/__init__.py @@ -0,0 +1,3 @@ +from .todo import Todo + +__all__ = ["Todo"] \ No newline at end of file diff --git a/app/models/todo.py b/app/models/todo.py new file mode 100644 index 0000000..2fec75b --- /dev/null +++ b/app/models/todo.py @@ -0,0 +1,14 @@ +from sqlalchemy import Boolean, Column, Integer, String, DateTime +from sqlalchemy.sql import func +from app.db.base import Base + + +class Todo(Base): + __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, nullable=False) + created_at = Column(DateTime(timezone=True), server_default=func.now()) + updated_at = Column(DateTime(timezone=True), onupdate=func.now()) \ No newline at end of file diff --git a/app/routes/__init__.py b/app/routes/__init__.py new file mode 100644 index 0000000..454c13f --- /dev/null +++ b/app/routes/__init__.py @@ -0,0 +1,3 @@ +from .todos import router as todos_router + +__all__ = ["todos_router"] \ No newline at end of file diff --git a/app/routes/todos.py b/app/routes/todos.py new file mode 100644 index 0000000..3622bf8 --- /dev/null +++ b/app/routes/todos.py @@ -0,0 +1,57 @@ +from typing import List +from fastapi import APIRouter, Depends, HTTPException +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) +def create_todo(todo: TodoCreate, db: Session = Depends(get_db)): + db_todo = TodoModel(**todo.dict()) + 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, db: Session = Depends(get_db)): + todos = db.query(TodoModel).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)): + todo = db.query(TodoModel).filter(TodoModel.id == todo_id).first() + if todo is None: + raise HTTPException(status_code=404, detail="Todo not found") + return todo + + +@router.put("/{todo_id}", response_model=Todo) +def update_todo(todo_id: int, todo_update: TodoUpdate, db: Session = Depends(get_db)): + todo = db.query(TodoModel).filter(TodoModel.id == todo_id).first() + if todo is None: + raise HTTPException(status_code=404, detail="Todo not found") + + update_data = todo_update.dict(exclude_unset=True) + for field, value in update_data.items(): + setattr(todo, field, value) + + db.commit() + db.refresh(todo) + return todo + + +@router.delete("/{todo_id}") +def delete_todo(todo_id: int, db: Session = Depends(get_db)): + todo = db.query(TodoModel).filter(TodoModel.id == todo_id).first() + if todo is None: + raise HTTPException(status_code=404, detail="Todo not found") + + db.delete(todo) + db.commit() + return {"message": "Todo deleted successfully"} \ No newline at end of file diff --git a/app/schemas/__init__.py b/app/schemas/__init__.py new file mode 100644 index 0000000..9761256 --- /dev/null +++ b/app/schemas/__init__.py @@ -0,0 +1,3 @@ +from .todo import Todo, TodoCreate, TodoUpdate + +__all__ = ["Todo", "TodoCreate", "TodoUpdate"] \ No newline at end of file diff --git a/app/schemas/todo.py b/app/schemas/todo.py new file mode 100644 index 0000000..84173b6 --- /dev/null +++ b/app/schemas/todo.py @@ -0,0 +1,28 @@ +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: + from_attributes = True \ No newline at end of file diff --git a/main.py b/main.py new file mode 100644 index 0000000..8962bc4 --- /dev/null +++ b/main.py @@ -0,0 +1,39 @@ +from fastapi import FastAPI +from fastapi.middleware.cors import CORSMiddleware +from app.routes import todos_router +from app.db.base import Base +from app.db.session import engine + +Base.metadata.create_all(bind=engine) + +app = FastAPI( + title="Todo App API", + description="A simple Todo application API built with FastAPI", + version="1.0.0", + openapi_url="/openapi.json" +) + +app.add_middleware( + CORSMiddleware, + allow_origins=["*"], + allow_credentials=True, + allow_methods=["*"], + allow_headers=["*"], +) + +app.include_router(todos_router, prefix="/todos", tags=["todos"]) + + +@app.get("/") +def root(): + return { + "title": "Todo App API", + "description": "A simple Todo application API built with FastAPI", + "documentation": "/docs", + "health": "/health" + } + + +@app.get("/health") +def health_check(): + return {"status": "healthy", "service": "todo-app"} \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..1da5204 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,6 @@ +fastapi==0.104.1 +uvicorn[standard]==0.24.0 +sqlalchemy==2.0.23 +alembic==1.12.1 +pydantic==2.5.0 +ruff==0.1.6 \ No newline at end of file