From 8a1b373ff6d50d5050b8c7280e7516ac04d2668c Mon Sep 17 00:00:00 2001 From: Automated Action Date: Mon, 12 May 2025 10:11:52 +0000 Subject: [PATCH] feat: Implement Todo API with FastAPI and SQLite - Setup project structure and dependencies - Create Todo model and SQLAlchemy database connection - Set up Alembic for database migrations - Implement CRUD operations and API endpoints - Add health check endpoint - Update README with project documentation generated with BackendIM... (backend.im) --- README.md | 59 ++++++++++++- alembic.ini | 84 +++++++++++++++++++ alembic/env.py | 83 ++++++++++++++++++ alembic/script.py.mako | 24 ++++++ .../b36e86b7fb37_create_todos_table.py | 36 ++++++++ app/__init__.py | 0 app/crud/__init__.py | 0 app/crud/todo.py | 45 ++++++++++ app/database.py | 31 +++++++ app/models/__init__.py | 0 app/models/todo.py | 16 ++++ app/routes/__init__.py | 2 + app/routes/health.py | 25 ++++++ app/routes/todo.py | 53 ++++++++++++ app/schemas/__init__.py | 1 + app/schemas/todo.py | 33 ++++++++ main.py | 26 ++++++ requirements.txt | 7 ++ 18 files changed, 523 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/b36e86b7fb37_create_todos_table.py create mode 100644 app/__init__.py create mode 100644 app/crud/__init__.py create mode 100644 app/crud/todo.py create mode 100644 app/database.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/health.py create mode 100644 app/routes/todo.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..0148532 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,58 @@ -# 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. + +## Features + +- Create, read, update, and delete todos +- Health check endpoint +- SQLite database with SQLAlchemy ORM +- Database migrations with Alembic + +## Project Structure + +``` +todoapi/ +├── alembic/ # Database migrations +│ └── versions/ # Migration versions +├── app/ # Application code +│ ├── crud/ # Database CRUD operations +│ ├── models/ # SQLAlchemy models +│ ├── routes/ # API routes +│ └── schemas/ # Pydantic schemas +├── main.py # FastAPI application entry point +├── requirements.txt # Python dependencies +└── alembic.ini # Alembic configuration +``` + +## API Endpoints + +### Todos + +- `GET /api/todos`: Get all todos +- `POST /api/todos`: Create a new todo +- `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 + +### Health Check + +- `GET /health`: Check API health + +## Setup and Installation + +1. Clone the repository +2. Install dependencies: + ``` + pip install -r requirements.txt + ``` +3. Run the application: + ``` + uvicorn main:app --reload + ``` + +## Documentation + +API documentation is available at: +- Swagger UI: `/docs` +- ReDoc: `/redoc` \ No newline at end of file diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..a4bc7ab --- /dev/null +++ b/alembic.ini @@ -0,0 +1,84 @@ +# 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 \ No newline at end of file diff --git a/alembic/env.py b/alembic/env.py new file mode 100644 index 0000000..f91e678 --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,83 @@ +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +from alembic import context +from pathlib import Path + +# 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 myapp import mymodel +# target_metadata = mymodel.Base.metadata +import sys +sys.path.insert(0, str(Path(__file__).parent.parent)) + +from app.models.todo import Todo +from app.database import Base +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() \ No newline at end of file diff --git a/alembic/script.py.mako b/alembic/script.py.mako new file mode 100644 index 0000000..1e4564e --- /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(): + ${upgrades if upgrades else "pass"} + + +def downgrade(): + ${downgrades if downgrades else "pass"} \ No newline at end of file diff --git a/alembic/versions/b36e86b7fb37_create_todos_table.py b/alembic/versions/b36e86b7fb37_create_todos_table.py new file mode 100644 index 0000000..9d5d4c3 --- /dev/null +++ b/alembic/versions/b36e86b7fb37_create_todos_table.py @@ -0,0 +1,36 @@ +"""create todos table + +Revision ID: b36e86b7fb37 +Revises: +Create Date: 2025-05-12 12:00:00.000000 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'b36e86b7fb37' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + op.create_table('todos', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('title', sa.String(), nullable=True), + sa.Column('description', sa.String(), nullable=True), + sa.Column('completed', sa.Boolean(), nullable=True), + sa.Column('created_at', sa.DateTime(timezone=True), 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(): + 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/__init__.py b/app/crud/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/crud/todo.py b/app/crud/todo.py new file mode 100644 index 0000000..844b6c9 --- /dev/null +++ b/app/crud/todo.py @@ -0,0 +1,45 @@ +from sqlalchemy.orm import Session +from typing import List, Optional +from app.models.todo import Todo +from app.schemas.todo import TodoCreate, TodoUpdate + + +def get_todos(db: Session, skip: int = 0, limit: int = 100) -> List[Todo]: + """Get all todos with pagination.""" + return db.query(Todo).order_by(Todo.created_at.desc()).offset(skip).limit(limit).all() + + +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 create_todo(db: Session, todo: TodoCreate) -> Todo: + """Create a new todo.""" + db_todo = Todo(**todo.dict()) + db.add(db_todo) + db.commit() + db.refresh(db_todo) + return db_todo + + +def update_todo(db: Session, todo_id: int, todo: TodoUpdate) -> Optional[Todo]: + """Update a todo by ID.""" + db_todo = get_todo(db, todo_id) + if db_todo: + update_data = todo.dict(exclude_unset=True) + for key, value in update_data.items(): + setattr(db_todo, key, value) + db.commit() + db.refresh(db_todo) + return db_todo + + +def delete_todo(db: Session, todo_id: int) -> bool: + """Delete a todo by ID.""" + db_todo = get_todo(db, todo_id) + if db_todo: + db.delete(db_todo) + db.commit() + return True + return False \ No newline at end of file diff --git a/app/database.py b/app/database.py new file mode 100644 index 0000000..f6b58a1 --- /dev/null +++ b/app/database.py @@ -0,0 +1,31 @@ +from pathlib import Path +from sqlalchemy import create_engine +from sqlalchemy.ext.declarative import declarative_base +from sqlalchemy.orm import sessionmaker + +# Create database directory +DB_DIR = Path("/app") / "storage" / "db" +DB_DIR.mkdir(parents=True, exist_ok=True) + +# Database URL +SQLALCHEMY_DATABASE_URL = f"sqlite:///{DB_DIR}/db.sqlite" + +# Create SQLAlchemy engine +engine = create_engine( + SQLALCHEMY_DATABASE_URL, + connect_args={"check_same_thread": False} +) + +# Create SessionLocal class +SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine) + +# Create Base class +Base = declarative_base() + +# Dependency +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..e69de29 diff --git a/app/models/todo.py b/app/models/todo.py new file mode 100644 index 0000000..c1577a8 --- /dev/null +++ b/app/models/todo.py @@ -0,0 +1,16 @@ +from sqlalchemy import Column, Integer, String, Boolean, DateTime +from sqlalchemy.sql import func +from app.database import Base + + +class Todo(Base): + """Todo model for the database.""" + + __tablename__ = "todos" + + id = Column(Integer, primary_key=True, index=True) + title = Column(String, index=True) + description = Column(String) + completed = Column(Boolean, default=False) + created_at = Column(DateTime(timezone=True), default=func.now()) + updated_at = Column(DateTime(timezone=True), default=func.now(), 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..e22492e --- /dev/null +++ b/app/routes/__init__.py @@ -0,0 +1,2 @@ +from app.routes.todo import router as todo_router +from app.routes.health import router as health_router \ No newline at end of file diff --git a/app/routes/health.py b/app/routes/health.py new file mode 100644 index 0000000..3176cd9 --- /dev/null +++ b/app/routes/health.py @@ -0,0 +1,25 @@ +from fastapi import APIRouter, Depends +from sqlalchemy.orm import Session +from app.database import get_db + +router = APIRouter( + prefix="/health", + tags=["health"], +) + + +@router.get("/") +def health_check(db: Session = Depends(get_db)): + """Health check endpoint to verify API and database connectivity.""" + try: + # Verify database connection by executing a simple query + db.execute("SELECT 1") + db_status = "healthy" + except Exception: + db_status = "unhealthy" + + return { + "status": "healthy", + "database": db_status, + "version": "0.1.0" + } \ No newline at end of file diff --git a/app/routes/todo.py b/app/routes/todo.py new file mode 100644 index 0000000..099f78c --- /dev/null +++ b/app/routes/todo.py @@ -0,0 +1,53 @@ +from fastapi import APIRouter, Depends, HTTPException, status, Response +from sqlalchemy.orm import Session +from typing import List + +from app.database import get_db +from app.schemas.todo import TodoCreate, TodoResponse, TodoUpdate +from app.crud.todo import get_todos, get_todo, create_todo, update_todo, delete_todo + +router = APIRouter( + prefix="/todos", + tags=["todos"], + responses={404: {"description": "Not found"}}, +) + + +@router.get("/", response_model=List[TodoResponse]) +def read_todos(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): + """Get all todos with pagination.""" + todos = get_todos(db, skip=skip, limit=limit) + return todos + + +@router.post("/", response_model=TodoResponse, status_code=status.HTTP_201_CREATED) +def create_todo_api(todo: TodoCreate, db: Session = Depends(get_db)): + """Create a new todo.""" + return create_todo(db=db, todo=todo) + + +@router.get("/{todo_id}", response_model=TodoResponse) +def read_todo(todo_id: int, db: Session = Depends(get_db)): + """Get a single todo by ID.""" + db_todo = get_todo(db, todo_id=todo_id) + if db_todo is None: + raise HTTPException(status_code=404, detail="Todo not found") + return db_todo + + +@router.put("/{todo_id}", response_model=TodoResponse) +def update_todo_api(todo_id: int, todo: TodoUpdate, db: Session = Depends(get_db)): + """Update a todo by ID.""" + db_todo = update_todo(db, todo_id=todo_id, todo=todo) + if db_todo is None: + raise HTTPException(status_code=404, detail="Todo not found") + return db_todo + + +@router.delete("/{todo_id}", status_code=status.HTTP_204_NO_CONTENT) +def delete_todo_api(todo_id: int, db: Session = Depends(get_db)): + """Delete a todo by ID.""" + success = delete_todo(db, todo_id=todo_id) + if not success: + raise HTTPException(status_code=404, detail="Todo not found") + return Response(status_code=status.HTTP_204_NO_CONTENT) \ No newline at end of file diff --git a/app/schemas/__init__.py b/app/schemas/__init__.py new file mode 100644 index 0000000..c714809 --- /dev/null +++ b/app/schemas/__init__.py @@ -0,0 +1 @@ +from app.schemas.todo import TodoBase, TodoCreate, TodoUpdate, TodoResponse \ No newline at end of file diff --git a/app/schemas/todo.py b/app/schemas/todo.py new file mode 100644 index 0000000..fb41aff --- /dev/null +++ b/app/schemas/todo.py @@ -0,0 +1,33 @@ +from pydantic import BaseModel, Field +from typing import Optional +from datetime import datetime + + +class TodoBase(BaseModel): + """Base Todo schema with common attributes.""" + title: str = Field(..., min_length=1, max_length=100) + description: Optional[str] = Field(None, max_length=1000) + completed: Optional[bool] = False + + +class TodoCreate(TodoBase): + """Schema for creating a new Todo.""" + pass + + +class TodoUpdate(BaseModel): + """Schema for updating a Todo.""" + title: Optional[str] = Field(None, min_length=1, max_length=100) + description: Optional[str] = Field(None, max_length=1000) + completed: Optional[bool] = None + + +class TodoResponse(TodoBase): + """Schema for Todo response including all fields.""" + id: int + created_at: datetime + updated_at: datetime + + class Config: + """Configure response schema to use orm mode.""" + orm_mode = True \ No newline at end of file diff --git a/main.py b/main.py new file mode 100644 index 0000000..d8d1713 --- /dev/null +++ b/main.py @@ -0,0 +1,26 @@ +from fastapi import FastAPI +from fastapi.middleware.cors import CORSMiddleware +from app.routes import todo_router, health_router +from app.database import engine, Base + +# Create database tables +Base.metadata.create_all(bind=engine) + +app = FastAPI( + title="Todo API", + description="A simple Todo API built with FastAPI", + version="0.1.0" +) + +# Configure CORS +app.add_middleware( + CORSMiddleware, + allow_origins=["*"], + allow_credentials=True, + allow_methods=["*"], + allow_headers=["*"], +) + +# Include routers +app.include_router(health_router) +app.include_router(todo_router, prefix="/api") diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..56dc38c --- /dev/null +++ b/requirements.txt @@ -0,0 +1,7 @@ +fastapi==0.104.1 +uvicorn==0.23.2 +sqlalchemy==2.0.23 +pydantic==2.4.2 +alembic==1.12.1 +python-dotenv==1.0.0 +python-multipart==0.0.6