diff --git a/README.md b/README.md index e8acfba..54d7412 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,83 @@ -# FastAPI Application +# Simple Todo Application - FastAPI -This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform. +A simple Todo API application built with FastAPI and SQLite. This RESTful API provides endpoints to create, read, update, and delete todo items. + +## Features + +- RESTful API for Todo management +- CRUD operations for Todo items +- SQLAlchemy ORM with SQLite database +- Alembic for database migrations +- FastAPI's automatic OpenAPI documentation + +## Project Structure + +``` +simpletodoapplication/ +├── alembic/ # Database migrations +│ ├── versions/ # Migration scripts +│ └── env.py # Alembic environment configuration +├── app/ # Application package +│ ├── api/ # API routes +│ │ └── routes/ # Route definitions +│ │ └── todos.py # Todo routes +│ ├── core/ # Core modules +│ │ └── config.py # Application configuration +│ ├── crud/ # CRUD operations +│ │ └── todo.py # Todo CRUD operations +│ ├── db/ # Database setup +│ │ └── base.py # Database connection +│ ├── models/ # SQLAlchemy models +│ │ └── todo.py # Todo model +│ └── schemas/ # Pydantic schemas +│ └── todo.py # Todo schemas +├── alembic.ini # Alembic configuration +├── main.py # Application entry point +└── requirements.txt # Project dependencies +``` + +## API Endpoints + +- **GET /api/v1/todos/** - Get all todos +- **POST /api/v1/todos/** - Create a new todo +- **GET /api/v1/todos/{todo_id}** - Get a specific todo +- **PUT /api/v1/todos/{todo_id}** - Update a todo +- **DELETE /api/v1/todos/{todo_id}** - Delete a todo +- **GET /health** - Health check endpoint +- **GET /docs** - API documentation (Swagger UI) +- **GET /redoc** - Alternative API documentation (ReDoc) + +## Setup and Running + +1. Install dependencies: + ``` + pip install -r requirements.txt + ``` + +2. Apply migrations: + ``` + alembic upgrade head + ``` + +3. Run the application: + ``` + uvicorn main:app --reload + ``` + +4. Access the API documentation at: + ``` + http://localhost:8000/docs + ``` + +## Todo Object Structure + +```json +{ + "id": 1, + "title": "Sample Todo", + "description": "This is a sample todo item", + "completed": false, + "created_at": "2025-05-13T12:00:00", + "updated_at": null +} +``` \ No newline at end of file diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..a625fa5 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,85 @@ +# 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/__init__.py b/alembic/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/alembic/env.py b/alembic/env.py new file mode 100644 index 0000000..090d87c --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,76 @@ +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +from alembic import context + +# 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 app.db.base import Base +from app.models.todo import Todo +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/4f42ebcf5b2d_create_todos_table.py b/alembic/versions/4f42ebcf5b2d_create_todos_table.py new file mode 100644 index 0000000..cab98e3 --- /dev/null +++ b/alembic/versions/4f42ebcf5b2d_create_todos_table.py @@ -0,0 +1,36 @@ +"""create todos table + +Revision ID: 4f42ebcf5b2d +Revises: +Create Date: 2025-05-13 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '4f42ebcf5b2d' +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=False), + sa.Column('description', sa.String(), nullable=True), + sa.Column('completed', sa.Boolean(), 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') + ) + 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/alembic/versions/__init__.py b/alembic/versions/__init__.py new file mode 100644 index 0000000..e69de29 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/routes/__init__.py b/app/api/routes/__init__.py new file mode 100644 index 0000000..f9e7575 --- /dev/null +++ b/app/api/routes/__init__.py @@ -0,0 +1,7 @@ +from fastapi import APIRouter +from app.api.routes import todos +from app.core.config import settings + +router = APIRouter() + +router.include_router(todos.router, prefix=f"{settings.API_V1_STR}/todos", tags=["todos"]) \ No newline at end of file diff --git a/app/api/routes/todos.py b/app/api/routes/todos.py new file mode 100644 index 0000000..5bb4810 --- /dev/null +++ b/app/api/routes/todos.py @@ -0,0 +1,44 @@ +from fastapi import APIRouter, Depends, HTTPException, status +from sqlalchemy.orm import Session +from typing import List + +from app import crud +from app.schemas.todo import Todo, TodoCreate, TodoUpdate +from app.db.base import get_db + +router = APIRouter() + + +@router.get("/", response_model=List[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 + + +@router.post("/", response_model=Todo, status_code=status.HTTP_201_CREATED) +def create_todo(todo: TodoCreate, db: Session = Depends(get_db)): + return crud.create_todo(db=db, todo=todo) + + +@router.get("/{todo_id}", response_model=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 + + +@router.put("/{todo_id}", response_model=Todo) +def update_todo(todo_id: int, todo: TodoUpdate, db: Session = Depends(get_db)): + db_todo = crud.update_todo(db=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(todo_id: int, db: Session = Depends(get_db)): + success = crud.delete_todo(db=db, todo_id=todo_id) + if not success: + raise HTTPException(status_code=404, detail="Todo not found") + return None \ 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..a93b0b6 --- /dev/null +++ b/app/core/config.py @@ -0,0 +1,13 @@ +from pathlib import Path +from pydantic_settings import BaseSettings + +class Settings(BaseSettings): + PROJECT_NAME: str = "SimpleTodoApp" + API_V1_STR: str = "/api/v1" + + # Database settings + DB_DIR = Path("/app") / "storage" / "db" + DB_DIR.mkdir(parents=True, exist_ok=True) + SQLALCHEMY_DATABASE_URL: str = f"sqlite:///{DB_DIR}/db.sqlite" + +settings = Settings() \ No newline at end of file diff --git a/app/crud/__init__.py b/app/crud/__init__.py new file mode 100644 index 0000000..f9baf71 --- /dev/null +++ b/app/crud/__init__.py @@ -0,0 +1 @@ +from app.crud.todo import get_todo, get_todos, create_todo, update_todo, delete_todo \ No newline at end of file diff --git a/app/crud/todo.py b/app/crud/todo.py new file mode 100644 index 0000000..f7a4e81 --- /dev/null +++ b/app/crud/todo.py @@ -0,0 +1,49 @@ +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_todo(db: Session, todo_id: int) -> Optional[Todo]: + return db.query(Todo).filter(Todo.id == todo_id).first() + + +def get_todos(db: Session, skip: int = 0, limit: int = 100) -> List[Todo]: + return db.query(Todo).order_by(Todo.created_at.desc()).offset(skip).limit(limit).all() + + +def create_todo(db: Session, todo: TodoCreate) -> Todo: + db_todo = Todo( + title=todo.title, + description=todo.description, + completed=todo.completed + ) + 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]: + db_todo = get_todo(db, todo_id) + if db_todo is None: + return None + + update_data = todo.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) -> bool: + db_todo = get_todo(db, todo_id) + if db_todo is None: + return False + + db.delete(db_todo) + db.commit() + return True \ 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..3089e14 --- /dev/null +++ b/app/db/base.py @@ -0,0 +1,22 @@ +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.SQLALCHEMY_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..d107325 --- /dev/null +++ b/app/models/__init__.py @@ -0,0 +1 @@ +from app.models.todo import 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..325465e --- /dev/null +++ b/app/models/todo.py @@ -0,0 +1,14 @@ +from sqlalchemy import Column, Integer, String, Boolean, DateTime +from sqlalchemy.sql import func + +from app.db.base 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(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..5d80af2 --- /dev/null +++ b/app/schemas/__init__.py @@ -0,0 +1 @@ +from app.schemas.todo import Todo, TodoCreate, TodoUpdate, TodoInDB \ No newline at end of file diff --git a/app/schemas/todo.py b/app/schemas/todo.py new file mode 100644 index 0000000..8a2df56 --- /dev/null +++ b/app/schemas/todo.py @@ -0,0 +1,27 @@ +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 TodoInDB(TodoBase): + id: int + created_at: datetime + updated_at: Optional[datetime] = None + + 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..3ae5f32 --- /dev/null +++ b/main.py @@ -0,0 +1,15 @@ +from fastapi import FastAPI +from app.api.routes import router as api_router +from app.core.config import settings + +app = FastAPI( + title=settings.PROJECT_NAME, + description="A simple Todo API application", + version="0.1.0", +) + +app.include_router(api_router) + +@app.get("/health", tags=["health"]) +async def health_check(): + return {"status": "healthy"} \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..5a524e1 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,6 @@ +fastapi==0.104.1 +uvicorn==0.23.2 +sqlalchemy==2.0.23 +alembic==1.12.1 +pydantic==2.4.2 +python-dotenv==1.0.0 \ No newline at end of file