From 7a43bab909f4651bc8b444932dbda30ab8a33e5a Mon Sep 17 00:00:00 2001 From: Automated Action Date: Thu, 19 Jun 2025 12:10:12 +0000 Subject: [PATCH] Add simple todo app backend with FastAPI - Create FastAPI application with CORS support - Add SQLAlchemy models for Todo with timestamps - Set up SQLite database with proper configuration - Create CRUD operations for todo management - Add REST API endpoints for all todo operations - Configure Alembic for database migrations - Add Pydantic schemas for request/response validation - Include health check and root info endpoints - Set up proper project structure following best practices - Add comprehensive README with usage instructions --- README.md | 58 +++++++++++- alembic.ini | 103 +++++++++++++++++++++ alembic/env.py | 81 ++++++++++++++++ alembic/script.py.mako | 24 +++++ alembic/versions/001_create_todos_table.py | 37 ++++++++ app/__init__.py | 0 app/crud.py | 33 +++++++ app/db/__init__.py | 0 app/db/base.py | 19 ++++ app/db/session.py | 8 ++ app/models.py | 13 +++ app/schemas.py | 24 +++++ main.py | 72 ++++++++++++++ requirements.txt | 5 + 14 files changed, 475 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_create_todos_table.py create mode 100644 app/__init__.py create mode 100644 app/crud.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.py create mode 100644 app/schemas.py create mode 100644 main.py create mode 100644 requirements.txt diff --git a/README.md b/README.md index e8acfba..51c4128 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,57 @@ -# FastAPI Application +# Todo App Backend -This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform. +A simple todo application backend built with FastAPI and SQLite. + +## Features + +- Create, read, update, and delete todos +- RESTful API endpoints +- SQLite database with SQLAlchemy ORM +- Database migrations with Alembic +- Automatic API documentation with Swagger UI +- CORS support for cross-origin requests + +## API Endpoints + +- `GET /` - Root endpoint with API information +- `GET /health` - Health check endpoint +- `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 + +## Installation + +1. Install dependencies: +```bash +pip install -r requirements.txt +``` + +2. The application will automatically create the database tables when started. + +## Usage + +Start the application: +```bash +uvicorn main:app --reload +``` + +The API will be available at: +- Main API: http://localhost:8000 +- Documentation: http://localhost:8000/docs +- Alternative docs: http://localhost:8000/redoc + +## Database + +The application uses SQLite database stored at `/app/storage/db/db.sqlite`. The database schema is managed with Alembic migrations. + +## Todo Schema + +Each todo has the following fields: +- `id`: Unique identifier +- `title`: Todo title (required) +- `description`: Optional description +- `completed`: Boolean status (default: false) +- `created_at`: Creation timestamp +- `updated_at`: Last update timestamp diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..7c3297c --- /dev/null +++ b/alembic.ini @@ -0,0 +1,103 @@ +# 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 +# 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 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 + +# set to 'true' to search source files recursively +# in each "version_locations" directory +# new in Alembic version 1.10 +# recursive_version_locations = false + +# 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 \ No newline at end of file diff --git a/alembic/env.py b/alembic/env.py new file mode 100644 index 0000000..6ffbabe --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,81 @@ +from logging.config import fileConfig +from sqlalchemy import engine_from_config +from sqlalchemy import pool +from alembic import context +import sys +from pathlib import Path + +# Add the project root to the Python path +sys.path.insert(0, str(Path(__file__).resolve().parents[1])) + +from app.db.base 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() -> 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() \ 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_create_todos_table.py b/alembic/versions/001_create_todos_table.py new file mode 100644 index 0000000..d55c920 --- /dev/null +++ b/alembic/versions/001_create_todos_table.py @@ -0,0 +1,37 @@ +"""Create todos 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: + # 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=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), server_default=sa.text('(CURRENT_TIMESTAMP)'), 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: + # Drop todos table + 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/crud.py b/app/crud.py new file mode 100644 index 0000000..8cac157 --- /dev/null +++ b/app/crud.py @@ -0,0 +1,33 @@ +from sqlalchemy.orm import Session +from . import models, schemas +from typing import List, Optional + +def get_todo(db: Session, todo_id: int) -> Optional[models.Todo]: + return db.query(models.Todo).filter(models.Todo.id == todo_id).first() + +def get_todos(db: Session, skip: int = 0, limit: int = 100) -> List[models.Todo]: + return db.query(models.Todo).offset(skip).limit(limit).all() + +def create_todo(db: Session, todo: schemas.TodoCreate) -> models.Todo: + db_todo = models.Todo(**todo.model_dump()) + db.add(db_todo) + db.commit() + db.refresh(db_todo) + return db_todo + +def update_todo(db: Session, todo_id: int, todo_update: schemas.TodoUpdate) -> Optional[models.Todo]: + db_todo = db.query(models.Todo).filter(models.Todo.id == todo_id).first() + if db_todo: + update_data = todo_update.model_dump(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) -> Optional[models.Todo]: + db_todo = db.query(models.Todo).filter(models.Todo.id == todo_id).first() + if db_todo: + db.delete(db_todo) + db.commit() + return db_todo \ No newline at end of file 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..50fa256 --- /dev/null +++ b/app/db/base.py @@ -0,0 +1,19 @@ +from sqlalchemy import create_engine +from sqlalchemy.ext.declarative import declarative_base +from sqlalchemy.orm import sessionmaker +from pathlib import Path + +# Database setup +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) + +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..fa66e05 --- /dev/null +++ b/app/db/session.py @@ -0,0 +1,8 @@ +from .base import SessionLocal + +def get_db(): + db = SessionLocal() + try: + yield db + finally: + db.close() \ No newline at end of file diff --git a/app/models.py b/app/models.py new file mode 100644 index 0000000..ea9fbde --- /dev/null +++ b/app/models.py @@ -0,0 +1,13 @@ +from sqlalchemy import Column, Integer, String, Boolean, DateTime +from sqlalchemy.sql import func +from .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), server_default=func.now(), onupdate=func.now()) \ No newline at end of file diff --git a/app/schemas.py b/app/schemas.py new file mode 100644 index 0000000..e464dbb --- /dev/null +++ b/app/schemas.py @@ -0,0 +1,24 @@ +from pydantic import BaseModel +from datetime import datetime +from typing import Optional + +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: datetime + + 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..7c5a577 --- /dev/null +++ b/main.py @@ -0,0 +1,72 @@ +from fastapi import FastAPI, Depends, HTTPException +from fastapi.middleware.cors import CORSMiddleware +from sqlalchemy.orm import Session +from typing import List + +from app.db.base import engine, Base +from app.db.session import get_db +from app import crud, schemas + +# Create database tables +Base.metadata.create_all(bind=engine) + +app = FastAPI( + title="Todo App API", + description="A simple todo application API", + version="1.0.0" +) + +# CORS configuration +app.add_middleware( + CORSMiddleware, + allow_origins=["*"], + allow_credentials=True, + allow_methods=["*"], + allow_headers=["*"], +) + +@app.get("/") +async def root(): + return { + "title": "Todo App API", + "documentation": "/docs", + "health": "/health" + } + +@app.get("/health") +async def health(): + return {"status": "healthy"} + +@app.post("/todos/", response_model=schemas.Todo) +def create_todo(todo: schemas.TodoCreate, db: Session = Depends(get_db)): + return crud.create_todo(db=db, todo=todo) + +@app.get("/todos/", response_model=List[schemas.Todo]) +def read_todos(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): + todos = crud.get_todos(db, skip=skip, limit=limit) + return todos + +@app.get("/todos/{todo_id}", response_model=schemas.Todo) +def read_todo(todo_id: int, db: Session = Depends(get_db)): + db_todo = crud.get_todo(db, todo_id=todo_id) + if db_todo is None: + raise HTTPException(status_code=404, detail="Todo not found") + return db_todo + +@app.put("/todos/{todo_id}", response_model=schemas.Todo) +def update_todo(todo_id: int, todo: schemas.TodoUpdate, db: Session = Depends(get_db)): + db_todo = crud.update_todo(db, todo_id=todo_id, todo_update=todo) + if db_todo is None: + raise HTTPException(status_code=404, detail="Todo not found") + return db_todo + +@app.delete("/todos/{todo_id}", response_model=schemas.Todo) +def delete_todo(todo_id: int, db: Session = Depends(get_db)): + db_todo = crud.delete_todo(db, todo_id=todo_id) + if db_todo is None: + raise HTTPException(status_code=404, detail="Todo not found") + return db_todo + +if __name__ == "__main__": + import uvicorn + uvicorn.run(app, host="0.0.0.0", port=8000) \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..cf772d0 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,5 @@ +fastapi==0.104.1 +uvicorn==0.24.0 +sqlalchemy==2.0.23 +alembic==1.12.1 +ruff==0.1.6 \ No newline at end of file