From f12950d8734b02d4937ffc88de2c13e9fa4456cf Mon Sep 17 00:00:00 2001 From: Automated Action Date: Thu, 22 May 2025 12:45:01 +0000 Subject: [PATCH] Create simple todo application with FastAPI and SQLite --- README.md | 109 +++++++++++++++++++- alembic.ini | 84 +++++++++++++++ app/__init__.py | 0 app/api/__init__.py | 0 app/api/endpoints/__init__.py | 0 app/api/endpoints/health.py | 25 +++++ app/api/endpoints/todos.py | 85 +++++++++++++++ app/api/routers.py | 11 ++ app/core/__init__.py | 0 app/core/config.py | 19 ++++ app/db/__init__.py | 0 app/db/session.py | 23 +++++ app/models/__init__.py | 3 + app/models/todo.py | 15 +++ app/schemas/__init__.py | 3 + app/schemas/todo.py | 33 ++++++ main.py | 29 ++++++ migrations/env.py | 86 +++++++++++++++ migrations/script.py.mako | 24 +++++ migrations/versions/01_initial_migration.py | 37 +++++++ requirements.txt | 7 ++ 21 files changed, 591 insertions(+), 2 deletions(-) create mode 100644 alembic.ini create mode 100644 app/__init__.py create mode 100644 app/api/__init__.py create mode 100644 app/api/endpoints/__init__.py create mode 100644 app/api/endpoints/health.py create mode 100644 app/api/endpoints/todos.py create mode 100644 app/api/routers.py create mode 100644 app/core/__init__.py create mode 100644 app/core/config.py create mode 100644 app/db/__init__.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/schemas/__init__.py create mode 100644 app/schemas/todo.py create mode 100644 main.py create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako create mode 100644 migrations/versions/01_initial_migration.py create mode 100644 requirements.txt diff --git a/README.md b/README.md index e8acfba..dbfcfe4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,108 @@ -# FastAPI Application +# Simple Todo Application -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 todo items +- Filter todos by completion status +- Database migrations using Alembic +- Health check endpoint +- API documentation + +## Requirements + +- Python 3.8+ +- FastAPI +- SQLAlchemy +- Alembic +- Uvicorn +- SQLite + +## Installation + +1. Clone this repository: + ```bash + git clone https://github.com/yourusername/simpletodoapplication.git + cd simpletodoapplication + ``` + +2. Install the dependencies: + ```bash + pip install -r requirements.txt + ``` + +3. Run the database migrations: + ```bash + alembic upgrade head + ``` + +## Running the Application + +Start the server with: + +```bash +uvicorn main:app --reload +``` + +The API will be available at http://localhost:8000. + +## API Documentation + +Once the application is running, you can access: + +- Swagger UI documentation: http://localhost:8000/docs +- ReDoc documentation: http://localhost:8000/redoc + +## API Endpoints + +### Health Check + +- `GET /health` - Check the health of the API + +### Todo Operations + +- `GET /api/v1/todos` - List all todos (optional query parameters: skip, limit, completed) +- `POST /api/v1/todos` - Create a new todo +- `GET /api/v1/todos/{todo_id}` - Get a specific todo +- `PATCH /api/v1/todos/{todo_id}` - Update a todo +- `DELETE /api/v1/todos/{todo_id}` - Delete a todo + +## Project Structure + +``` +simpletodoapplication/ +├── alembic.ini +├── app/ +│ ├── api/ +│ │ ├── endpoints/ +│ │ │ ├── health.py +│ │ │ └── todos.py +│ │ └── routers.py +│ ├── core/ +│ │ └── config.py +│ ├── db/ +│ │ └── session.py +│ ├── models/ +│ │ └── todo.py +│ └── schemas/ +│ └── todo.py +├── main.py +├── migrations/ +│ ├── env.py +│ ├── script.py.mako +│ └── versions/ +│ └── 01_initial_migration.py +└── requirements.txt +``` + +## Data Models + +### Todo + +- `id`: Integer (Primary Key) +- `title`: String (Required) +- `description`: String (Optional) +- `completed`: Boolean (Default: False) +- `created_at`: DateTime +- `updated_at`: DateTime \ No newline at end of file diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..75005f9 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,84 @@ +# 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 migrations/versions. When using multiple version +# directories, initial revisions must be specified with --version-path +# version_locations = %(here)s/bar %(here)s/bat migrations/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/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..e69de29 diff --git a/app/api/endpoints/__init__.py b/app/api/endpoints/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/api/endpoints/health.py b/app/api/endpoints/health.py new file mode 100644 index 0000000..a694f87 --- /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.session import get_db + +router = APIRouter() + + +@router.get("/health") +def health_check(db: Session = Depends(get_db)): + """ + Check the health of the API. + """ + # Check database connection + try: + # Execute a simple query + db.execute("SELECT 1") + db_status = "healthy" + except Exception as e: + db_status = f"unhealthy: {str(e)}" + + return { + "status": "healthy", + "database": db_status, + } \ No newline at end of file diff --git a/app/api/endpoints/todos.py b/app/api/endpoints/todos.py new file mode 100644 index 0000000..f797c2f --- /dev/null +++ b/app/api/endpoints/todos.py @@ -0,0 +1,85 @@ +from typing import List, Optional +from fastapi import APIRouter, Depends, HTTPException, status +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.get("/todos", response_model=List[Todo]) +def read_todos( + skip: int = 0, + limit: int = 100, + completed: Optional[bool] = None, + db: Session = Depends(get_db), +): + """ + Retrieve todos. + """ + query = db.query(TodoModel) + + # Filter by completed status if provided + if completed is not None: + query = query.filter(TodoModel.completed == completed) + + todos = query.offset(skip).limit(limit).all() + return todos + + +@router.post("/todos", response_model=Todo, status_code=status.HTTP_201_CREATED) +def create_todo(todo: TodoCreate, db: Session = Depends(get_db)): + """ + Create new todo. + """ + db_todo = TodoModel(**todo.model_dump()) + db.add(db_todo) + db.commit() + db.refresh(db_todo) + return db_todo + + +@router.get("/todos/{todo_id}", response_model=Todo) +def read_todo(todo_id: int, db: Session = Depends(get_db)): + """ + Get todo by ID. + """ + 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.patch("/todos/{todo_id}", response_model=Todo) +def update_todo(todo_id: int, todo: TodoUpdate, db: Session = Depends(get_db)): + """ + Update a todo. + """ + 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_data = todo.model_dump(exclude_unset=True) + for key, value in update_data.items(): + setattr(db_todo, key, value) + + db.add(db_todo) + db.commit() + db.refresh(db_todo) + return db_todo + + +@router.delete("/todos/{todo_id}", status_code=status.HTTP_204_NO_CONTENT, response_model=None) +def delete_todo(todo_id: int, db: Session = Depends(get_db)): + """ + Delete a todo. + """ + 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 None \ No newline at end of file diff --git a/app/api/routers.py b/app/api/routers.py new file mode 100644 index 0000000..cbe35d5 --- /dev/null +++ b/app/api/routers.py @@ -0,0 +1,11 @@ +from fastapi import APIRouter + +from app.api.endpoints import todos, health + +# Create routers +todo_router = APIRouter() +health_router = APIRouter() + +# Include endpoints in routers +todo_router.include_router(todos.router) +health_router.include_router(health.router) \ No newline at end of file diff --git a/app/core/__init__.py b/app/core/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/core/config.py b/app/core/config.py new file mode 100644 index 0000000..f4efd8e --- /dev/null +++ b/app/core/config.py @@ -0,0 +1,19 @@ +from pathlib import Path +from typing import List + +from pydantic import BaseModel + + +class Settings(BaseModel): + PROJECT_NAME: str = "SimpleTodo API" + VERSION: str = "0.1.0" + DESCRIPTION: str = "A simple Todo API built with FastAPI and SQLite" + CORS_ORIGINS: List[str] = ["*"] + + # Database settings + DB_DIR = Path("/app") / "storage" / "db" + DB_DIR.mkdir(parents=True, exist_ok=True) + DATABASE_URL: str = f"sqlite:///{DB_DIR}/db.sqlite" + + +settings = Settings() \ 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/session.py b/app/db/session.py new file mode 100644 index 0000000..1194a2f --- /dev/null +++ b/app/db/session.py @@ -0,0 +1,23 @@ +from sqlalchemy import create_engine +from sqlalchemy.ext.declarative import declarative_base +from sqlalchemy.orm import sessionmaker + +from app.core.config import settings + +engine = create_engine( + settings.DATABASE_URL, + connect_args={"check_same_thread": False} +) + +SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine) + +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..4dec223 --- /dev/null +++ b/app/models/__init__.py @@ -0,0 +1,3 @@ +from app.models.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..8454827 --- /dev/null +++ b/app/models/todo.py @@ -0,0 +1,15 @@ +from datetime import datetime +from sqlalchemy import Column, Integer, String, Boolean, DateTime + +from app.db.session import Base + + +class Todo(Base): + __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, default=datetime.utcnow) + updated_at = Column(DateTime, default=datetime.utcnow, onupdate=datetime.utcnow) \ No newline at end of file diff --git a/app/schemas/__init__.py b/app/schemas/__init__.py new file mode 100644 index 0000000..21717bb --- /dev/null +++ b/app/schemas/__init__.py @@ -0,0 +1,3 @@ +from app.schemas.todo import Todo, TodoCreate, TodoUpdate, TodoInDB, TodoBase + +__all__ = ["Todo", "TodoCreate", "TodoUpdate", "TodoInDB", "TodoBase"] \ No newline at end of file diff --git a/app/schemas/todo.py b/app/schemas/todo.py new file mode 100644 index 0000000..fe80f7b --- /dev/null +++ b/app/schemas/todo.py @@ -0,0 +1,33 @@ +from datetime import datetime +from typing import Optional + +from pydantic import BaseModel, Field + + +class TodoBase(BaseModel): + title: str = Field(..., min_length=1, max_length=100) + description: Optional[str] = Field(None, max_length=500) + completed: bool = False + + +class TodoCreate(TodoBase): + pass + + +class TodoUpdate(BaseModel): + title: Optional[str] = Field(None, min_length=1, max_length=100) + description: Optional[str] = Field(None, max_length=500) + completed: Optional[bool] = None + + +class TodoInDB(TodoBase): + id: int + created_at: datetime + updated_at: datetime + + class Config: + from_attributes = True + + +class Todo(TodoInDB): + pass \ No newline at end of file diff --git a/main.py b/main.py new file mode 100644 index 0000000..7c69608 --- /dev/null +++ b/main.py @@ -0,0 +1,29 @@ +from fastapi import FastAPI +from fastapi.middleware.cors import CORSMiddleware + +from app.api.routers import todo_router, health_router +from app.core.config import settings + +app = FastAPI( + title=settings.PROJECT_NAME, + version=settings.VERSION, + description=settings.DESCRIPTION, +) + +# Set up CORS middleware +app.add_middleware( + CORSMiddleware, + allow_origins=settings.CORS_ORIGINS, + allow_credentials=True, + allow_methods=["*"], + allow_headers=["*"], +) + +# Include routers +app.include_router(health_router, tags=["health"]) +app.include_router(todo_router, prefix="/api/v1", tags=["todos"]) + +if __name__ == "__main__": + import uvicorn + + uvicorn.run("main:app", host="0.0.0.0", port=8000, reload=True) \ No newline at end of file diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 0000000..2cbf865 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,86 @@ +import os +import sys +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +from alembic import context + +# Add the parent directory to sys.path +sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))) + +# Import models +from app.db.session 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. +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(): + """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: + is_sqlite = connection.dialect.name == 'sqlite' + context.configure( + connection=connection, + target_metadata=target_metadata, + render_as_batch=is_sqlite, # Key configuration for 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..1e4564e --- /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(): + ${upgrades if upgrades else "pass"} + + +def downgrade(): + ${downgrades if downgrades else "pass"} \ No newline at end of file diff --git a/migrations/versions/01_initial_migration.py b/migrations/versions/01_initial_migration.py new file mode 100644 index 0000000..f7f4f94 --- /dev/null +++ b/migrations/versions/01_initial_migration.py @@ -0,0 +1,37 @@ +"""Initial migration + +Revision ID: 01_initial_migration +Revises: +Create Date: 2023-09-25 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '01_initial_migration' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # 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(), nullable=False), + sa.Column('updated_at', sa.DateTime(), nullable=False), + 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/requirements.txt b/requirements.txt new file mode 100644 index 0000000..c913a4d --- /dev/null +++ b/requirements.txt @@ -0,0 +1,7 @@ +fastapi>=0.103.1 +uvicorn>=0.23.2 +sqlalchemy>=2.0.20 +pydantic>=2.4.0 +alembic>=1.12.0 +python-dotenv>=1.0.0 +ruff>=0.0.290 \ No newline at end of file