From 328e65d56a3edd528685fe657a96f174961dd7cd Mon Sep 17 00:00:00 2001 From: Automated Action Date: Mon, 26 May 2025 18:34:58 +0000 Subject: [PATCH] Create FastAPI Todo application with SQLite database --- README.md | 116 +++++++++++++++++- alembic.ini | 106 ++++++++++++++++ app/__init__.py | 1 + app/api/__init__.py | 1 + app/api/api.py | 9 ++ app/api/routes/__init__.py | 1 + app/api/routes/health.py | 20 +++ app/api/routes/todos.py | 75 +++++++++++ app/core/config.py | 21 ++++ app/db/deps.py | 14 +++ app/db/session.py | 14 +++ app/models/__init__.py | 4 + app/models/todo.py | 15 +++ app/schemas/__init__.py | 4 + app/schemas/todo.py | 29 +++++ app/services/__init__.py | 1 + app/services/todo.py | 60 +++++++++ main.py | 35 ++++++ migrations/__init__.py | 1 + migrations/env.py | 81 ++++++++++++ migrations/script.py.mako | 24 ++++ migrations/versions/001_create_todos_table.py | 38 ++++++ migrations/versions/__init__.py | 1 + requirements.txt | 9 ++ 24 files changed, 678 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/api.py create mode 100644 app/api/routes/__init__.py create mode 100644 app/api/routes/health.py create mode 100644 app/api/routes/todos.py create mode 100644 app/core/config.py create mode 100644 app/db/deps.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 app/services/__init__.py create mode 100644 app/services/todo.py create mode 100644 main.py create mode 100644 migrations/__init__.py create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako create mode 100644 migrations/versions/001_create_todos_table.py create mode 100644 migrations/versions/__init__.py create mode 100644 requirements.txt diff --git a/README.md b/README.md index e8acfba..6084b03 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,115 @@ -# FastAPI Application +# FastAPI Todo Application -This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform. +This is a simple Todo application API built with FastAPI and SQLite. It provides endpoints for creating, reading, updating, and deleting todo items. + +## Features + +- RESTful API for todo management +- CRUD operations for todo items +- SQLite database with SQLAlchemy ORM +- Database migrations with Alembic +- API documentation with Swagger UI and ReDoc +- Health check endpoint + +## Project Structure + +``` +todoapp/ +├── alembic.ini # Alembic configuration +├── app/ # Application package +│ ├── api/ # API routes +│ │ ├── api.py # API router +│ │ └── routes/ # API route modules +│ │ ├── health.py # Health check endpoint +│ │ └── todos.py # Todo endpoints +│ ├── core/ # Core application modules +│ │ └── config.py # Application configuration +│ ├── db/ # Database modules +│ │ ├── deps.py # Database dependencies +│ │ └── session.py # Database session +│ ├── models/ # SQLAlchemy models +│ │ └── todo.py # Todo model +│ ├── schemas/ # Pydantic schemas +│ │ └── todo.py # Todo schemas +│ └── services/ # Business logic services +│ └── todo.py # Todo service +├── main.py # Application entry point +├── migrations/ # Alembic migrations +│ ├── env.py # Alembic environment +│ ├── script.py.mako # Migration script template +│ └── versions/ # Migration scripts +│ └── 001_create_todos_table.py # Initial migration +├── README.md # Project documentation +├── requirements.txt # Project dependencies +└── storage/ # Data storage directory + └── db/ # Database files +``` + +## Getting Started + +### Prerequisites + +- Python 3.8 or higher +- pip (Python package installer) + +### Installation + +1. Clone the repository: + ```bash + git clone + cd todoapp + ``` + +2. Install the dependencies: + ```bash + pip install -r requirements.txt + ``` + +3. Run the migrations to create the database: + ```bash + alembic upgrade head + ``` + +4. Start the application: + ```bash + uvicorn main:app --reload + ``` + +The API will be available at http://localhost:8000. + +## API Documentation + +Once the application is running, you can access the API documentation at: + +- Swagger UI: http://localhost:8000/docs +- ReDoc: http://localhost:8000/redoc + +## 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 /api/v1/health`: API health check +- `GET /health`: Alternative health check endpoint + +## Database + +The application uses SQLite as the database. The database file is stored in `storage/db/db.sqlite`. + +## Development + +### Code Style + +This project uses Ruff for linting and formatting. + +To lint the code: +```bash +ruff check . +``` + +To format the code: +```bash +ruff format . +``` \ No newline at end of file diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..a3ae2b7 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,106 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = migrations + +# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s +# Uncomment the line below if you want the files to be prepended with date and time +# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file +# for all available tokens +# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s + +# sys.path path, will be prepended to sys.path if present. +# defaults to the current working directory. +prepend_sys_path = . + +# timezone to use when rendering the date within the migration file +# as well as the filename. +# If specified, requires the python-dateutil library that can be +# installed by adding `alembic[tz]` to the pip requirements +# 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. +# The path separator used here should be the separator specified by "version_path_separator" below. +# version_locations = %(here)s/bar:%(here)s/bat:migrations/versions + +# version path separator; As mentioned above, this is the character used to split +# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep. +# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas. +# Valid values for version_path_separator are: +# +# version_path_separator = : +# version_path_separator = ; +# version_path_separator = space +version_path_separator = os # Use os.pathsep. Default configuration used for new projects. + +# 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 REVISION_SCRIPT_FILENAME + +# 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..253a656 --- /dev/null +++ b/app/__init__.py @@ -0,0 +1 @@ +# This file makes the app directory a Python package diff --git a/app/api/__init__.py b/app/api/__init__.py new file mode 100644 index 0000000..4a1e636 --- /dev/null +++ b/app/api/__init__.py @@ -0,0 +1 @@ +# This file makes the api directory a Python package diff --git a/app/api/api.py b/app/api/api.py new file mode 100644 index 0000000..2c4787f --- /dev/null +++ b/app/api/api.py @@ -0,0 +1,9 @@ +from fastapi import APIRouter + +from app.api.routes import todos, health + +api_router = APIRouter() + +# Include all route modules +api_router.include_router(todos.router, prefix="/todos", tags=["todos"]) +api_router.include_router(health.router, prefix="/health", tags=["health"]) diff --git a/app/api/routes/__init__.py b/app/api/routes/__init__.py new file mode 100644 index 0000000..ac0d5b4 --- /dev/null +++ b/app/api/routes/__init__.py @@ -0,0 +1 @@ +# This file makes the routes directory a Python package diff --git a/app/api/routes/health.py b/app/api/routes/health.py new file mode 100644 index 0000000..17c5f26 --- /dev/null +++ b/app/api/routes/health.py @@ -0,0 +1,20 @@ +from fastapi import APIRouter, Depends +from sqlalchemy.orm import Session + +from app.db.deps import get_db + +router = APIRouter() + + +@router.get("/") +def health_check(db: Session = Depends(get_db)): + """ + Health check endpoint to verify API is up and running + and can connect to the database. + """ + try: + # Execute a simple query to check database connection + db.execute("SELECT 1") + return {"status": "ok", "message": "API is healthy"} + except Exception as e: + return {"status": "error", "message": f"API health check failed: {str(e)}"} diff --git a/app/api/routes/todos.py b/app/api/routes/todos.py new file mode 100644 index 0000000..cb17ddf --- /dev/null +++ b/app/api/routes/todos.py @@ -0,0 +1,75 @@ +from typing import List +from fastapi import APIRouter, Depends, HTTPException, status +from sqlalchemy.orm import Session + +from app.db.deps import get_db +from app.schemas.todo import Todo as TodoSchema +from app.schemas.todo import TodoCreate, TodoUpdate +from app.services.todo import ( + get_todos, + get_todo, + create_todo, + update_todo, + delete_todo, +) + +router = APIRouter() + + +@router.get("/", response_model=List[TodoSchema]) +def read_todos(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): + """ + Retrieve todos. + """ + todos = get_todos(db, skip=skip, limit=limit) + return todos + + +@router.post("/", response_model=TodoSchema, status_code=status.HTTP_201_CREATED) +def create_new_todo(todo_in: TodoCreate, db: Session = Depends(get_db)): + """ + Create new todo. + """ + todo = create_todo(db=db, todo=todo_in) + return todo + + +@router.get("/{todo_id}", response_model=TodoSchema) +def read_todo(todo_id: int, db: Session = Depends(get_db)): + """ + Get a specific todo by id. + """ + todo = get_todo(db=db, todo_id=todo_id) + if todo is None: + raise HTTPException( + status_code=status.HTTP_404_NOT_FOUND, detail="Todo not found" + ) + return todo + + +@router.put("/{todo_id}", response_model=TodoSchema) +def update_todo_item(todo_id: int, todo_in: TodoUpdate, db: Session = Depends(get_db)): + """ + Update a todo. + """ + todo = update_todo(db=db, todo_id=todo_id, todo_update=todo_in) + if todo is None: + raise HTTPException( + status_code=status.HTTP_404_NOT_FOUND, detail="Todo not found" + ) + return todo + + +@router.delete( + "/{todo_id}", status_code=status.HTTP_204_NO_CONTENT, response_model=None +) +def delete_todo_item(todo_id: int, db: Session = Depends(get_db)): + """ + Delete a todo. + """ + deleted = delete_todo(db=db, todo_id=todo_id) + if not deleted: + raise HTTPException( + status_code=status.HTTP_404_NOT_FOUND, detail="Todo not found" + ) + return None diff --git a/app/core/config.py b/app/core/config.py new file mode 100644 index 0000000..cc7da1e --- /dev/null +++ b/app/core/config.py @@ -0,0 +1,21 @@ +from pathlib import Path +from pydantic_settings import BaseSettings + + +class Settings(BaseSettings): + API_V1_STR: str = "/api/v1" + PROJECT_NAME: str = "Todo App API" + PROJECT_DESCRIPTION: str = "A simple Todo app API built with FastAPI and SQLite" + PROJECT_VERSION: str = "0.1.0" + + # 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" + + class Config: + case_sensitive = True + env_file = ".env" + + +settings = Settings() diff --git a/app/db/deps.py b/app/db/deps.py new file mode 100644 index 0000000..b704a56 --- /dev/null +++ b/app/db/deps.py @@ -0,0 +1,14 @@ +from typing import Generator + +from app.db.session import SessionLocal + + +def get_db() -> Generator: + """ + Get a database session for use in FastAPI dependency injection. + """ + db = SessionLocal() + try: + yield db + finally: + db.close() diff --git a/app/db/session.py b/app/db/session.py new file mode 100644 index 0000000..8312c50 --- /dev/null +++ b/app/db/session.py @@ -0,0 +1,14 @@ +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}, # needed only for SQLite +) + +SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine) + +Base = declarative_base() diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 0000000..f106f51 --- /dev/null +++ b/app/models/__init__.py @@ -0,0 +1,4 @@ +from app.models.todo import Todo + +# This will make our models importable from app.models +__all__ = ["Todo"] diff --git a/app/models/todo.py b/app/models/todo.py new file mode 100644 index 0000000..05248a4 --- /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) diff --git a/app/schemas/__init__.py b/app/schemas/__init__.py new file mode 100644 index 0000000..c7bd3e4 --- /dev/null +++ b/app/schemas/__init__.py @@ -0,0 +1,4 @@ +from app.schemas.todo import Todo, TodoCreate, TodoUpdate + +# This will make our schemas importable from app.schemas +__all__ = ["Todo", "TodoCreate", "TodoUpdate"] diff --git a/app/schemas/todo.py b/app/schemas/todo.py new file mode 100644 index 0000000..23c46fa --- /dev/null +++ b/app/schemas/todo.py @@ -0,0 +1,29 @@ +from datetime import datetime +from typing import Optional + +from pydantic import BaseModel + + +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 Todo(TodoBase): + id: int + created_at: datetime + updated_at: datetime + + class Config: + orm_mode = True diff --git a/app/services/__init__.py b/app/services/__init__.py new file mode 100644 index 0000000..fbfabb8 --- /dev/null +++ b/app/services/__init__.py @@ -0,0 +1 @@ +# This file makes the services directory a Python package diff --git a/app/services/todo.py b/app/services/todo.py new file mode 100644 index 0000000..228c4c2 --- /dev/null +++ b/app/services/todo.py @@ -0,0 +1,60 @@ +from typing import List, Optional +from sqlalchemy.orm import Session + +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 a list of todos from the database. + """ + return db.query(Todo).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 in the database. + """ + 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_update: TodoUpdate) -> Optional[Todo]: + """ + Update an existing todo in the database. + """ + db_todo = get_todo(db, todo_id) + if db_todo is None: + return None + + update_data = todo_update.dict(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: + """ + Delete a todo from the database. + """ + db_todo = get_todo(db, todo_id) + if db_todo is None: + return False + + db.delete(db_todo) + db.commit() + return True diff --git a/main.py b/main.py new file mode 100644 index 0000000..a5a7ac3 --- /dev/null +++ b/main.py @@ -0,0 +1,35 @@ +import uvicorn +from fastapi import FastAPI +from starlette.middleware.cors import CORSMiddleware + +from app.api.api import api_router +from app.core.config import settings + +app = FastAPI( + title=settings.PROJECT_NAME, + description=settings.PROJECT_DESCRIPTION, + version=settings.PROJECT_VERSION, + openapi_url=f"{settings.API_V1_STR}/openapi.json", +) + +# Set all CORS enabled origins +app.add_middleware( + CORSMiddleware, + allow_origins=["*"], # Allow all origins in development environment + allow_credentials=True, + allow_methods=["*"], + allow_headers=["*"], +) + +# Include API router +app.include_router(api_router, prefix=settings.API_V1_STR) + + +# Health check endpoint at root level +@app.get("/health") +async def health(): + return {"status": "ok", "message": "API is healthy"} + + +if __name__ == "__main__": + uvicorn.run("main:app", host="0.0.0.0", port=8000, reload=True) diff --git a/migrations/__init__.py b/migrations/__init__.py new file mode 100644 index 0000000..c4696eb --- /dev/null +++ b/migrations/__init__.py @@ -0,0 +1 @@ +# This file makes the migrations directory a Python package diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 0000000..bcd8520 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,81 @@ +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool +from app.db.session import Base + +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. +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: + is_sqlite = connection.dialect.name == "sqlite" + context.configure( + connection=connection, + target_metadata=target_metadata, + render_as_batch=is_sqlite, # Enables batch mode for SQLite + compare_type=True, + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() 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/001_create_todos_table.py b/migrations/versions/001_create_todos_table.py new file mode 100644 index 0000000..0e864ad --- /dev/null +++ b/migrations/versions/001_create_todos_table.py @@ -0,0 +1,38 @@ +"""create todos table + +Revision ID: 001 +Revises: +Create Date: 2023-11-12 + +""" + +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = "001" +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade() -> None: + 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() -> None: + 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") diff --git a/migrations/versions/__init__.py b/migrations/versions/__init__.py new file mode 100644 index 0000000..c7e27f6 --- /dev/null +++ b/migrations/versions/__init__.py @@ -0,0 +1 @@ +# This file makes the migrations/versions directory a Python package diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..f5453e1 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,9 @@ +fastapi==0.104.1 +uvicorn==0.23.2 +sqlalchemy==2.0.23 +alembic==1.12.1 +pydantic==2.4.2 +pydantic-settings==2.0.3 +python-dotenv==1.0.0 +ruff==0.1.4 +pathlib==1.0.1 \ No newline at end of file