diff --git a/README.md b/README.md index e8acfba..6bce725 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,102 @@ -# FastAPI Application +# Simple Todo API -This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform. +A deadass simple Todo API built with FastAPI and SQLite. This project provides a RESTful API for managing todo items with the basic CRUD operations. + +## Features + +- RESTful API endpoints for Todo resource (Create, Read, Update, Delete) +- SQLite database with SQLAlchemy ORM +- Database migrations with Alembic +- Health check endpoint +- Interactive API documentation (Swagger & ReDoc) + +## Project Structure + +``` +simpletodoapi/ +├── alembic.ini +├── app/ +│ ├── api/ +│ │ ├── endpoints/ +│ │ │ ├── health.py +│ │ │ └── todo.py +│ │ └── __init__.py +│ ├── core/ +│ │ └── __init__.py +│ ├── db/ +│ │ ├── database.py +│ │ └── __init__.py +│ ├── models/ +│ │ ├── todo.py +│ │ └── __init__.py +│ ├── schemas/ +│ │ ├── todo.py +│ │ └── __init__.py +│ └── __init__.py +├── migrations/ +│ ├── env.py +│ ├── script.py.mako +│ ├── versions/ +│ │ ├── 20231111_initial_migration.py +│ │ └── __init__.py +│ └── __init__.py +├── main.py +└── requirements.txt +``` + +## Installation + +1. Clone the repository + +2. Install dependencies: +```bash +pip install -r requirements.txt +``` + +3. Run the application: +```bash +uvicorn main:app --reload +``` + +The API will be available at http://localhost:8000 + +## API Endpoints + +### Health Check +- `GET /health` - Check API and database health + +### Todo Management +- `GET /api/v1/todos` - Get all todos (with optional pagination and filtering) +- `GET /api/v1/todos/{todo_id}` - Get a specific todo by ID +- `POST /api/v1/todos` - Create a new todo +- `PUT /api/v1/todos/{todo_id}` - Update an existing todo +- `DELETE /api/v1/todos/{todo_id}` - Delete a todo + +## API Documentation + +Interactive API documentation is available at: +- Swagger UI: http://localhost:8000/docs +- ReDoc: http://localhost:8000/redoc + +## Database + +The application uses SQLite as the database. The database file is stored at `/app/storage/db/db.sqlite`. + +Database migrations are managed with Alembic. The initial migration is already included to set up the todos table. + +## Development + +To run the development server with hot-reload: +```bash +uvicorn main:app --reload +``` + +To lint the codebase: +```bash +ruff check . +``` + +To auto-fix linting issues: +```bash +ruff check --fix . +``` \ No newline at end of file diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..0b25c53 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,85 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = migrations + +# 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 + +# SQLite URL with absolute path +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/app/__init__.py b/app/__init__.py new file mode 100644 index 0000000..d95b0f0 --- /dev/null +++ b/app/__init__.py @@ -0,0 +1 @@ +# App package initialization diff --git a/app/api/__init__.py b/app/api/__init__.py new file mode 100644 index 0000000..6758a96 --- /dev/null +++ b/app/api/__init__.py @@ -0,0 +1 @@ +# API package initialization diff --git a/app/api/endpoints/__init__.py b/app/api/endpoints/__init__.py new file mode 100644 index 0000000..59e01ac --- /dev/null +++ b/app/api/endpoints/__init__.py @@ -0,0 +1,5 @@ +# Re-export routers for API endpoints +from app.api.endpoints.todo import router as todo_router +from app.api.endpoints.health import router as health_router + +__all__ = ["todo_router", "health_router"] diff --git a/app/api/endpoints/health.py b/app/api/endpoints/health.py new file mode 100644 index 0000000..3b0ec2b --- /dev/null +++ b/app/api/endpoints/health.py @@ -0,0 +1,25 @@ +from fastapi import APIRouter, Depends +from sqlalchemy.orm import Session +from app.db.database import get_db + +router = APIRouter() + +@router.get("/health", summary="Check service health") +def health_check(db: Session = Depends(get_db)): + """ + Check the health status of the API and database connection. + + Returns: + dict: Health status information + """ + # Try to execute a simple query to verify DB connection + try: + db.execute("SELECT 1").fetchall() + db_status = "healthy" + except Exception as e: + db_status = f"unhealthy: {str(e)}" + + return { + "status": "ok", + "database": db_status + } \ No newline at end of file diff --git a/app/api/endpoints/todo.py b/app/api/endpoints/todo.py new file mode 100644 index 0000000..854cd1b --- /dev/null +++ b/app/api/endpoints/todo.py @@ -0,0 +1,109 @@ +from typing import List, Optional +from fastapi import APIRouter, Depends, HTTPException, status, Response, Query +from sqlalchemy.orm import Session + +from app.db.database import get_db +from app.models.todo import Todo as TodoModel +from app.schemas.todo import Todo, TodoCreate, TodoUpdate + +router = APIRouter() + +@router.post("/todos", response_model=Todo, status_code=status.HTTP_201_CREATED, summary="Create a new todo") +def create_todo(todo: TodoCreate, db: Session = Depends(get_db)): + """ + Create a new todo item. + + - **title**: Required title of the todo + - **description**: Optional detailed description + - **completed**: Whether the todo is completed (defaults to False) + + Returns the created todo item. + """ + db_todo = TodoModel(**todo.model_dump()) + db.add(db_todo) + db.commit() + db.refresh(db_todo) + return db_todo + + +@router.get("/todos", response_model=List[Todo], summary="Get all todos") +def read_todos( + skip: int = 0, + limit: int = 100, + completed: Optional[bool] = Query(None, description="Filter by completion status"), + db: Session = Depends(get_db) +): + """ + Get all todo items with optional filtering. + + - **skip**: Number of items to skip (pagination) + - **limit**: Maximum number of items to return + - **completed**: Optional filter by completion status + + Returns a list of todo items. + """ + query = db.query(TodoModel) + + # Apply filter if completed parameter is provided + if completed is not None: + query = query.filter(TodoModel.completed == completed) + + todos = query.offset(skip).limit(limit).all() + return todos + + +@router.get("/todos/{todo_id}", response_model=Todo, summary="Get a specific todo") +def read_todo(todo_id: int, db: Session = Depends(get_db)): + """ + Get a specific todo item by ID. + + - **todo_id**: The ID of the todo to retrieve + + Returns the todo item or raises a 404 if not found. + """ + db_todo = db.query(TodoModel).filter(TodoModel.id == todo_id).first() + if db_todo is None: + raise HTTPException(status_code=404, detail="Todo not found") + return db_todo + + +@router.put("/todos/{todo_id}", response_model=Todo, summary="Update a todo") +def update_todo(todo_id: int, todo: TodoUpdate, db: Session = Depends(get_db)): + """ + Update a todo item. + + - **todo_id**: The ID of the todo to update + - **todo**: The updated todo data + + Returns the updated todo item or raises a 404 if not found. + """ + db_todo = db.query(TodoModel).filter(TodoModel.id == todo_id).first() + if db_todo is None: + raise HTTPException(status_code=404, detail="Todo not found") + + # Update fields if provided in the request + todo_data = todo.model_dump(exclude_unset=True) + for key, value in todo_data.items(): + setattr(db_todo, key, value) + + db.commit() + db.refresh(db_todo) + return db_todo + + +@router.delete("/todos/{todo_id}", status_code=status.HTTP_204_NO_CONTENT, response_model=None, summary="Delete a todo") +def delete_todo(todo_id: int, db: Session = Depends(get_db)): + """ + Delete a todo item. + + - **todo_id**: The ID of the todo to delete + + Returns no content on success or raises a 404 if not found. + """ + db_todo = db.query(TodoModel).filter(TodoModel.id == todo_id).first() + if db_todo is None: + raise HTTPException(status_code=404, detail="Todo not found") + + db.delete(db_todo) + db.commit() + return Response(status_code=status.HTTP_204_NO_CONTENT) \ No newline at end of file diff --git a/app/core/__init__.py b/app/core/__init__.py new file mode 100644 index 0000000..cab174e --- /dev/null +++ b/app/core/__init__.py @@ -0,0 +1 @@ +# Core package initialization diff --git a/app/db/__init__.py b/app/db/__init__.py new file mode 100644 index 0000000..b476390 --- /dev/null +++ b/app/db/__init__.py @@ -0,0 +1 @@ +# Database package initialization diff --git a/app/db/database.py b/app/db/database.py new file mode 100644 index 0000000..a83aee1 --- /dev/null +++ b/app/db/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 if it doesn't exist +DB_DIR = Path("/app") / "storage" / "db" +DB_DIR.mkdir(parents=True, exist_ok=True) + +# Define SQLite 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} # Needed for SQLite +) + +# Create sessionmaker +SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine) + +# Create Base class for models +Base = declarative_base() + +# Dependency to get DB session +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..c595e41 --- /dev/null +++ b/app/models/__init__.py @@ -0,0 +1,2 @@ +# Import all models here for Alembic auto migrations +from app.models.todo import Todo # noqa: F401 diff --git a/app/models/todo.py b/app/models/todo.py new file mode 100644 index 0000000..c649d1d --- /dev/null +++ b/app/models/todo.py @@ -0,0 +1,15 @@ +from sqlalchemy import Boolean, Column, Integer, String, DateTime +from sqlalchemy.sql import func +from app.db.database import Base + +class Todo(Base): + """Todo model for storing task items.""" + + __tablename__ = "todos" + + id = Column(Integer, primary_key=True, index=True) + title = Column(String, index=True) + 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), onupdate=func.now()) \ No newline at end of file diff --git a/app/schemas/__init__.py b/app/schemas/__init__.py new file mode 100644 index 0000000..30e0a3c --- /dev/null +++ b/app/schemas/__init__.py @@ -0,0 +1 @@ +# Schemas package initialization diff --git a/app/schemas/todo.py b/app/schemas/todo.py new file mode 100644 index 0000000..f372124 --- /dev/null +++ b/app/schemas/todo.py @@ -0,0 +1,27 @@ +from datetime import datetime +from typing import Optional +from pydantic import BaseModel, Field, ConfigDict + +# Base Todo schema with common attributes +class TodoBase(BaseModel): + title: str = Field(..., min_length=1, max_length=100, description="Title of the todo item") + description: Optional[str] = Field(None, max_length=500, description="Optional description of the todo") + completed: bool = Field(False, description="Whether the todo is completed") + +# Schema for creating a new Todo +class TodoCreate(TodoBase): + pass + +# Schema for updating an existing Todo +class TodoUpdate(BaseModel): + title: Optional[str] = Field(None, min_length=1, max_length=100, description="Title of the todo item") + description: Optional[str] = Field(None, max_length=500, description="Optional description of the todo") + completed: Optional[bool] = Field(None, description="Whether the todo is completed") + +# Schema for returning a Todo from the API +class Todo(TodoBase): + id: int + created_at: datetime + updated_at: Optional[datetime] = None + + model_config = ConfigDict(from_attributes=True) # Updated configuration for Pydantic v2 \ No newline at end of file diff --git a/main.py b/main.py new file mode 100644 index 0000000..bf5b0ec --- /dev/null +++ b/main.py @@ -0,0 +1,28 @@ +from fastapi import FastAPI +from fastapi.middleware.cors import CORSMiddleware +import uvicorn + +# Import routers +from app.api.endpoints import todo_router, health_router + +app = FastAPI( + title="Simple Todo API", + description="A dead simple Todo API built with FastAPI and SQLite", + version="0.1.0", +) + +# Add CORS middleware +app.add_middleware( + CORSMiddleware, + allow_origins=["*"], # For a production app, replace with specific origins + allow_credentials=True, + allow_methods=["*"], + allow_headers=["*"], +) + +# Include routers +app.include_router(todo_router, prefix="/api/v1", tags=["todos"]) +app.include_router(health_router, tags=["health"]) + +if __name__ == "__main__": + uvicorn.run("main:app", host="0.0.0.0", port=8000, reload=True) \ No newline at end of file diff --git a/migrations/__init__.py b/migrations/__init__.py new file mode 100644 index 0000000..17e4857 --- /dev/null +++ b/migrations/__init__.py @@ -0,0 +1 @@ +# Migrations package initialization \ No newline at end of file diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 0000000..261703d --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,85 @@ +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +from alembic import context + +# Import Base, models and add your model's MetaData object here +from app.db.database 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: + # Check if we're using SQLite + is_sqlite = connection.dialect.name == "sqlite" + + context.configure( + connection=connection, + target_metadata=target_metadata, + # For SQLite, use batch mode for better alter table support + render_as_batch=is_sqlite, + ) + + 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/migrations/script.py.mako b/migrations/script.py.mako new file mode 100644 index 0000000..37d0cac --- /dev/null +++ b/migrations/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/migrations/versions/20231111_initial_migration.py b/migrations/versions/20231111_initial_migration.py new file mode 100644 index 0000000..422c977 --- /dev/null +++ b/migrations/versions/20231111_initial_migration.py @@ -0,0 +1,41 @@ +"""Initial migration for todo table + +Revision ID: 0001 +Revises: +Create Date: 2023-11-11 + +""" +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() -> 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, default=False), + sa.Column('created_at', sa.DateTime(timezone=True), server_default=sa.text('(CURRENT_TIMESTAMP)')), + sa.Column('updated_at', sa.DateTime(timezone=True), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + + # Create index on title for faster searching + 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/migrations/versions/__init__.py b/migrations/versions/__init__.py new file mode 100644 index 0000000..1266868 --- /dev/null +++ b/migrations/versions/__init__.py @@ -0,0 +1 @@ +# Migrations versions package initialization \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..8830e38 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,8 @@ +fastapi>=0.104.0 +uvicorn>=0.23.2 +sqlalchemy>=2.0.0 +alembic>=1.12.0 +pydantic>=2.0.0 +ruff>=0.1.0 +pathlib>=1.0.1 +python-dotenv>=1.0.0 \ No newline at end of file