From af0f9e16385d28a892b84c9e3857ecf0e9a00798 Mon Sep 17 00:00:00 2001 From: Automated Action Date: Wed, 18 Jun 2025 00:22:56 +0000 Subject: [PATCH] Build barebones task manager API with FastAPI and SQLite - Create FastAPI application with CORS support - Implement Task model with SQLAlchemy - Set up database session and migrations with Alembic - Add CRUD endpoints for task management - Include health check and API documentation endpoints - Configure Ruff for code formatting and linting --- README.md | 53 +++++++++++++++++++- alembic.ini | 42 ++++++++++++++++ alembic/env.py | 50 +++++++++++++++++++ alembic/script.py.mako | 23 +++++++++ alembic/versions/001_create_tasks_table.py | 44 +++++++++++++++++ app/__init__.py | 0 app/api/__init__.py | 3 ++ app/api/tasks.py | 57 ++++++++++++++++++++++ app/db/__init__.py | 4 ++ app/db/base.py | 3 ++ app/db/session.py | 22 +++++++++ app/models/__init__.py | 3 ++ app/models/task.py | 16 ++++++ app/schemas.py | 28 +++++++++++ main.py | 33 +++++++++++++ requirements.txt | 6 +++ 16 files changed, 385 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_tasks_table.py create mode 100644 app/__init__.py create mode 100644 app/api/__init__.py create mode 100644 app/api/tasks.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/task.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..cd40df6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,52 @@ -# FastAPI Application +# Task Manager API -This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform. +A barebones task manager API built with FastAPI and SQLite. + +## Features + +- Create, read, update, and delete tasks +- SQLite database with Alembic migrations +- RESTful API endpoints +- Health check endpoint +- CORS support +- OpenAPI documentation + +## Requirements + +- Python 3.8+ +- FastAPI +- SQLite + +## Installation + +1. Install dependencies: +```bash +pip install -r requirements.txt +``` + +2. Run the application: +```bash +uvicorn main:app --reload +``` + +The API will be available at `http://localhost:8000` + +## API Endpoints + +- `GET /` - API information +- `GET /health` - Health check +- `GET /api/v1/tasks/` - List all tasks +- `POST /api/v1/tasks/` - Create a new task +- `GET /api/v1/tasks/{task_id}` - Get a specific task +- `PUT /api/v1/tasks/{task_id}` - Update a task +- `DELETE /api/v1/tasks/{task_id}` - Delete a task + +## Documentation + +- OpenAPI spec: `http://localhost:8000/openapi.json` +- Swagger UI: `http://localhost:8000/docs` +- ReDoc: `http://localhost:8000/redoc` + +## Database + +The application uses SQLite with the database file stored at `/app/storage/db/db.sqlite`. diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..aab6a65 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,42 @@ +[alembic] +script_location = alembic +prepend_sys_path = . +version_path_separator = os +sqlalchemy.url = sqlite:////app/storage/db/db.sqlite +version_locations = %(here)s/alembic/versions + +[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..8ce8edd --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,50 @@ +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__).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() diff --git a/alembic/script.py.mako b/alembic/script.py.mako new file mode 100644 index 0000000..4a32725 --- /dev/null +++ b/alembic/script.py.mako @@ -0,0 +1,23 @@ +"""${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 = ${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_tasks_table.py b/alembic/versions/001_create_tasks_table.py new file mode 100644 index 0000000..933ffc1 --- /dev/null +++ b/alembic/versions/001_create_tasks_table.py @@ -0,0 +1,44 @@ +"""create tasks table + +Revision ID: 001 +Revises: +Create Date: 2024-01-01 12:00:00.000000 + +""" + +from alembic import op +import sqlalchemy as sa + +revision = "001" +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade() -> None: + op.create_table( + "tasks", + 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), + 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_tasks_id"), "tasks", ["id"], unique=False) + + +def downgrade() -> None: + op.drop_index(op.f("ix_tasks_id"), table_name="tasks") + op.drop_table("tasks") diff --git a/app/__init__.py b/app/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/api/__init__.py b/app/api/__init__.py new file mode 100644 index 0000000..60ebd02 --- /dev/null +++ b/app/api/__init__.py @@ -0,0 +1,3 @@ +from .tasks import router as tasks_router + +__all__ = ["tasks_router"] diff --git a/app/api/tasks.py b/app/api/tasks.py new file mode 100644 index 0000000..c963a1b --- /dev/null +++ b/app/api/tasks.py @@ -0,0 +1,57 @@ +from fastapi import APIRouter, Depends, HTTPException +from sqlalchemy.orm import Session +from typing import List +from app.db import get_db +from app.models import Task +from app.schemas import TaskCreate, TaskUpdate, Task as TaskSchema + +router = APIRouter() + + +@router.post("/tasks/", response_model=TaskSchema) +def create_task(task: TaskCreate, db: Session = Depends(get_db)): + db_task = Task(**task.dict()) + db.add(db_task) + db.commit() + db.refresh(db_task) + return db_task + + +@router.get("/tasks/", response_model=List[TaskSchema]) +def read_tasks(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): + tasks = db.query(Task).offset(skip).limit(limit).all() + return tasks + + +@router.get("/tasks/{task_id}", response_model=TaskSchema) +def read_task(task_id: int, db: Session = Depends(get_db)): + task = db.query(Task).filter(Task.id == task_id).first() + if task is None: + raise HTTPException(status_code=404, detail="Task not found") + return task + + +@router.put("/tasks/{task_id}", response_model=TaskSchema) +def update_task(task_id: int, task_update: TaskUpdate, db: Session = Depends(get_db)): + task = db.query(Task).filter(Task.id == task_id).first() + if task is None: + raise HTTPException(status_code=404, detail="Task not found") + + update_data = task_update.dict(exclude_unset=True) + for field, value in update_data.items(): + setattr(task, field, value) + + db.commit() + db.refresh(task) + return task + + +@router.delete("/tasks/{task_id}") +def delete_task(task_id: int, db: Session = Depends(get_db)): + task = db.query(Task).filter(Task.id == task_id).first() + if task is None: + raise HTTPException(status_code=404, detail="Task not found") + + db.delete(task) + db.commit() + return {"message": "Task deleted successfully"} diff --git a/app/db/__init__.py b/app/db/__init__.py new file mode 100644 index 0000000..8b0c3f5 --- /dev/null +++ b/app/db/__init__.py @@ -0,0 +1,4 @@ +from .base import Base +from .session import get_db, engine + +__all__ = ["Base", "get_db", "engine"] diff --git a/app/db/base.py b/app/db/base.py new file mode 100644 index 0000000..860e542 --- /dev/null +++ b/app/db/base.py @@ -0,0 +1,3 @@ +from sqlalchemy.ext.declarative import declarative_base + +Base = declarative_base() diff --git a/app/db/session.py b/app/db/session.py new file mode 100644 index 0000000..fbff7a0 --- /dev/null +++ b/app/db/session.py @@ -0,0 +1,22 @@ +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() diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 0000000..187db78 --- /dev/null +++ b/app/models/__init__.py @@ -0,0 +1,3 @@ +from .task import Task + +__all__ = ["Task"] diff --git a/app/models/task.py b/app/models/task.py new file mode 100644 index 0000000..858ecc1 --- /dev/null +++ b/app/models/task.py @@ -0,0 +1,16 @@ +from sqlalchemy import Column, Integer, String, Boolean, DateTime +from sqlalchemy.sql import func +from app.db.base import Base + + +class Task(Base): + __tablename__ = "tasks" + + id = Column(Integer, primary_key=True, index=True) + title = Column(String, nullable=False) + description = Column(String, nullable=True) + completed = Column(Boolean, default=False) + created_at = Column(DateTime(timezone=True), server_default=func.now()) + updated_at = Column( + DateTime(timezone=True), server_default=func.now(), onupdate=func.now() + ) diff --git a/app/schemas.py b/app/schemas.py new file mode 100644 index 0000000..3ed2151 --- /dev/null +++ b/app/schemas.py @@ -0,0 +1,28 @@ +from pydantic import BaseModel +from datetime import datetime +from typing import Optional + + +class TaskBase(BaseModel): + title: str + description: Optional[str] = None + completed: bool = False + + +class TaskCreate(TaskBase): + pass + + +class TaskUpdate(BaseModel): + title: Optional[str] = None + description: Optional[str] = None + completed: Optional[bool] = None + + +class Task(TaskBase): + id: int + created_at: datetime + updated_at: datetime + + class Config: + from_attributes = True diff --git a/main.py b/main.py new file mode 100644 index 0000000..6799d5a --- /dev/null +++ b/main.py @@ -0,0 +1,33 @@ +from fastapi import FastAPI +from fastapi.middleware.cors import CORSMiddleware +from app.api import tasks_router +from app.db import Base, engine + +Base.metadata.create_all(bind=engine) + +app = FastAPI( + title="Task Manager API", + description="A simple task manager 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(tasks_router, prefix="/api/v1") + + +@app.get("/") +def read_root(): + return {"title": "Task Manager API", "documentation": "/docs", "health": "/health"} + + +@app.get("/health") +def health_check(): + return {"status": "healthy", "service": "Task Manager API"} diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..b9515ae --- /dev/null +++ b/requirements.txt @@ -0,0 +1,6 @@ +fastapi==0.104.1 +uvicorn==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