From 951e85ac7afbf9cf5b63213842fc586c460b2d43 Mon Sep 17 00:00:00 2001 From: Automated Action Date: Fri, 16 May 2025 10:29:16 +0000 Subject: [PATCH] Create Todo application with FastAPI and SQLite --- README.md | 78 ++++++++++++- alembic.ini | 105 ++++++++++++++++++ app/__init__.py | 0 app/api/__init__.py | 0 app/api/api.py | 9 ++ app/api/endpoints/__init__.py | 0 app/api/endpoints/health.py | 20 ++++ app/api/endpoints/todos.py | 103 +++++++++++++++++ app/core/__init__.py | 0 app/core/config.py | 15 +++ app/crud/__init__.py | 7 ++ app/crud/crud_todo.py | 62 +++++++++++ app/db/__init__.py | 0 app/db/session.py | 21 ++++ app/models/__init__.py | 0 app/models/todo.py | 15 +++ app/schemas/__init__.py | 0 app/schemas/todo.py | 34 ++++++ main.py | 17 +++ migrations/README | 1 + migrations/env.py | 83 ++++++++++++++ migrations/script.py.mako | 24 ++++ migrations/versions/001_create_todos_table.py | 36 ++++++ pyproject.toml | 18 +++ requirements.txt | 8 ++ 25 files changed, 654 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/endpoints/__init__.py create mode 100644 app/api/endpoints/health.py create mode 100644 app/api/endpoints/todos.py create mode 100644 app/core/__init__.py create mode 100644 app/core/config.py create mode 100644 app/crud/__init__.py create mode 100644 app/crud/crud_todo.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/README 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 pyproject.toml create mode 100644 requirements.txt diff --git a/README.md b/README.md index e8acfba..9543c31 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,77 @@ -# FastAPI Application +# Todo Application with FastAPI -This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform. +This is a simple Todo Application backend built with FastAPI and SQLite. + +## Features + +- RESTful API for managing todo items +- CRUD operations for todos +- SQLite database with SQLAlchemy ORM +- Database migrations with Alembic +- OpenAPI documentation + +## Getting Started + +### Prerequisites + +- Python 3.8+ + +### Installation + +1. Clone the repository +2. Install dependencies: + ```bash + pip install -r requirements.txt + ``` +3. Run database migrations: + ```bash + alembic upgrade head + ``` +4. Start the application: + ```bash + uvicorn main:app --reload + ``` + +The application will be available at http://localhost:8000. + +## API Documentation + +After starting the server, you can access the interactive API documentation at: + +- Swagger UI: http://localhost:8000/docs +- ReDoc: http://localhost:8000/redoc + +## API Endpoints + +- **GET /api/v1/todos**: List all todos (can filter by completion status) +- **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**: Health check endpoint + +## Project Structure + +``` +. +├── alembic.ini # Alembic configuration +├── app # Application package +│ ├── api # API endpoints +│ │ ├── api.py # API router +│ │ └── endpoints # API endpoint modules +│ │ ├── health.py # Health check endpoint +│ │ └── todos.py # Todo endpoints +│ ├── core # Core modules +│ │ └── config.py # Application configuration +│ ├── crud # CRUD operations +│ │ └── crud_todo.py # CRUD for todos +│ ├── db # Database modules +│ │ └── session.py # Database session +│ ├── models # SQLAlchemy models +│ │ └── todo.py # Todo model +│ └── schemas # Pydantic schemas +│ └── todo.py # Todo schemas +├── main.py # Application entry point +├── migrations # Alembic migrations +└── requirements.txt # Project dependencies +``` \ No newline at end of file diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..b78212c --- /dev/null +++ b/alembic.ini @@ -0,0 +1,105 @@ +# 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 + +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..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/api.py b/app/api/api.py new file mode 100644 index 0000000..bfe91db --- /dev/null +++ b/app/api/api.py @@ -0,0 +1,9 @@ +from fastapi import APIRouter + +from app.api.endpoints import health, todos + +api_router = APIRouter() + +# Include routers from endpoints +api_router.include_router(health.router, tags=["health"]) +api_router.include_router(todos.router, prefix="/todos", tags=["todos"]) \ No newline at end of file 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..08b0c85 --- /dev/null +++ b/app/api/endpoints/health.py @@ -0,0 +1,20 @@ +from fastapi import APIRouter, Depends +from sqlalchemy.orm import Session + +from app.db.session import get_db + +router = APIRouter() + +@router.get("/health", summary="Health check endpoint") +def health_check(db: Session = Depends(get_db)): + try: + # Make a simple query to check if the database is responsive + db.execute("SELECT 1") + db_status = "healthy" + except Exception: + db_status = "unhealthy" + + return { + "status": "ok", + "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..e24751d --- /dev/null +++ b/app/api/endpoints/todos.py @@ -0,0 +1,103 @@ +from typing import List, Optional + +from fastapi import APIRouter, Depends, HTTPException, status +from sqlalchemy.orm import Session + +from app import crud +from app.db.session import get_db +from app.schemas.todo import Todo, TodoCreate, TodoUpdate + +router = APIRouter() + + +@router.get("/", response_model=List[Todo]) +def read_todos( + skip: int = 0, + limit: int = 100, + completed: Optional[bool] = None, + db: Session = Depends(get_db), +): + """ + Retrieve todos. + + - **skip**: Number of records to skip for pagination + - **limit**: Maximum number of records to retrieve + - **completed**: Filter todos by completion status (optional) + """ + todos = crud.crud_todo.get_todos(db, skip=skip, limit=limit, completed=completed) + return todos + + +@router.post("/", response_model=Todo, status_code=status.HTTP_201_CREATED) +def create_todo( + todo_in: TodoCreate, + db: Session = Depends(get_db), +): + """ + Create new todo. + + - **title**: Title for the todo (required) + - **description**: Detailed description (optional) + - **completed**: Completion status (defaults to False) + """ + return crud.crud_todo.create_todo(db=db, todo=todo_in) + + +@router.get("/{todo_id}", response_model=Todo) +def read_todo( + todo_id: int, + db: Session = Depends(get_db), +): + """ + Get specific todo by ID. + + - **todo_id**: The ID of the todo to retrieve + """ + db_todo = crud.crud_todo.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_in: TodoUpdate, + db: Session = Depends(get_db), +): + """ + Update a todo. + + - **todo_id**: The ID of the todo to update + - **title**: New title (optional) + - **description**: New description (optional) + - **completed**: New completion status (optional) + """ + db_todo = crud.crud_todo.get_todo(db, todo_id=todo_id) + if db_todo is None: + raise HTTPException(status_code=404, detail="Todo not found") + + db_todo = crud.crud_todo.update_todo(db=db, todo_id=todo_id, todo_in=todo_in) + return db_todo + + +@router.delete( + "/{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. + + - **todo_id**: The ID of the todo to delete + """ + db_todo = crud.crud_todo.get_todo(db, todo_id=todo_id) + if db_todo is None: + raise HTTPException(status_code=404, detail="Todo not found") + + crud.crud_todo.delete_todo(db=db, todo_id=todo_id) + 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..09ccad9 --- /dev/null +++ b/app/core/config.py @@ -0,0 +1,15 @@ +from pathlib import Path + +from pydantic_settings import BaseSettings + + +class Settings(BaseSettings): + API_V1_STR: str = "/api/v1" + PROJECT_NAME: str = "Todo Application" + + # 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..b30ef6f --- /dev/null +++ b/app/crud/__init__.py @@ -0,0 +1,7 @@ +from app.crud.crud_todo import ( # noqa + get_todo, + get_todos, + create_todo, + update_todo, + delete_todo, +) \ No newline at end of file diff --git a/app/crud/crud_todo.py b/app/crud/crud_todo.py new file mode 100644 index 0000000..749f074 --- /dev/null +++ b/app/crud/crud_todo.py @@ -0,0 +1,62 @@ +from typing import Any, Dict, List, Optional, Union + +from sqlalchemy.orm import Session + +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, completed: Optional[bool] = None +) -> List[Todo]: + query = db.query(Todo) + if completed is not None: + query = query.filter(Todo.completed == completed) + return query.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_in: Union[TodoUpdate, Dict[str, Any]] +) -> Optional[Todo]: + db_todo = get_todo(db, todo_id) + if not db_todo: + return None + + if isinstance(todo_in, dict): + update_data = todo_in + else: + update_data = todo_in.model_dump(exclude_unset=True) + + for field, value in update_data.items(): + setattr(db_todo, field, value) + + db.add(db_todo) + db.commit() + db.refresh(db_todo) + return db_todo + + +def delete_todo(db: Session, todo_id: int) -> Optional[Todo]: + db_todo = get_todo(db, todo_id) + if not db_todo: + return None + + db.delete(db_todo) + db.commit() + return db_todo \ 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..678c03e --- /dev/null +++ b/app/db/session.py @@ -0,0 +1,21 @@ +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 +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..e69de29 diff --git a/app/models/todo.py b/app/models/todo.py new file mode 100644 index 0000000..0aab896 --- /dev/null +++ b/app/models/todo.py @@ -0,0 +1,15 @@ +from sqlalchemy import Boolean, Column, DateTime, Integer, String +from sqlalchemy.sql import func + +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(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..e69de29 diff --git a/app/schemas/todo.py b/app/schemas/todo.py new file mode 100644 index 0000000..d3a6611 --- /dev/null +++ b/app/schemas/todo.py @@ -0,0 +1,34 @@ +from datetime import datetime +from typing import Optional + +from pydantic import BaseModel, Field + + +# Shared properties +class TodoBase(BaseModel): + title: str = Field(..., min_length=1, max_length=100) + description: Optional[str] = Field(None, max_length=1000) + completed: bool = False + +# Properties to receive on Todo creation +class TodoCreate(TodoBase): + pass + +# Properties to receive on Todo update +class TodoUpdate(BaseModel): + title: Optional[str] = Field(None, min_length=1, max_length=100) + description: Optional[str] = Field(None, max_length=1000) + completed: Optional[bool] = None + +# Properties shared by models in the DB +class TodoInDBBase(TodoBase): + id: int + created_at: datetime + updated_at: Optional[datetime] = None + + class Config: + from_attributes = True + +# Properties to return to client +class Todo(TodoInDBBase): + pass \ No newline at end of file diff --git a/main.py b/main.py new file mode 100644 index 0000000..d313dde --- /dev/null +++ b/main.py @@ -0,0 +1,17 @@ +import uvicorn +from fastapi import FastAPI + +from app.api.api import api_router +from app.core.config import settings + +app = FastAPI( + title=settings.PROJECT_NAME, + openapi_url=f"{settings.API_V1_STR}/openapi.json", + description="Todo application API", + version="0.1.0", +) + +app.include_router(api_router, prefix=settings.API_V1_STR) + +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/README b/migrations/README new file mode 100644 index 0000000..98e4f9c --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 0000000..d6e87bf --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,83 @@ +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. +if config.config_file_name is not None: + fileConfig(config.config_file_name) + +# Import all models here +from app.db.session import Base +from app.models.todo import Todo + +# 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, # 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..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..21d6989 --- /dev/null +++ b/migrations/versions/001_create_todos_table.py @@ -0,0 +1,36 @@ +"""create todos table + +Revision ID: 001 +Revises: +Create Date: 2023-10-10 + +""" +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, index=True), + 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.func.now()), + 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) + + +def downgrade() -> None: + op.drop_index(op.f('ix_todos_id'), table_name='todos') + op.drop_index(op.f('ix_todos_title'), table_name='todos') + op.drop_table('todos') \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..8ef28c5 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,18 @@ +[tool.ruff] +line-length = 88 +target-version = "py38" +exclude = [ + ".git", + ".ruff_cache", + ".venv", + "venv", + "__pypackages__", + "migrations", +] + +[tool.ruff.lint] +select = ["E", "F", "I"] +ignore = [] + +[tool.ruff.lint.isort] +known-third-party = ["fastapi", "pydantic", "sqlalchemy", "alembic", "starlette"] \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..25d7839 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,8 @@ +fastapi>=0.95.0 +uvicorn>=0.22.0 +sqlalchemy>=2.0.0 +pydantic>=2.0.0 +python-multipart>=0.0.6 +python-jose[cryptography]>=3.3.0 +alembic>=1.10.0 +ruff>=0.0.277 \ No newline at end of file