diff --git a/README.md b/README.md index e8acfba..4ee64c6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,107 @@ -# FastAPI Application +# Simple Todo App -This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform. +A simple Todo application built with FastAPI and SQLite. + +## Features + +- Create, read, update, and delete todo items +- SQLite database with SQLAlchemy ORM +- Alembic migrations for database version control +- API documentation using FastAPI's built-in Swagger UI and ReDoc + +## Project Structure + +``` +simpletodoapp/ +├── app/ +│ ├── api/ +│ │ ├── __init__.py +│ │ └── routes.py +│ ├── db/ +│ │ ├── __init__.py +│ │ ├── database.py +│ │ └── models.py +│ ├── schemas/ +│ │ ├── __init__.py +│ │ └── todo.py +│ ├── services/ +│ │ ├── __init__.py +│ │ └── todo.py +│ └── __init__.py +├── migrations/ +│ ├── versions/ +│ │ └── 1f87c1e94e6a_create_todos_table.py +│ ├── env.py +│ └── script.py.mako +├── alembic.ini +├── main.py +├── README.md +└── requirements.txt +``` + +## Prerequisites + +- Python 3.7+ +- pip + +## Installation + +1. Clone the repository: + +```bash +git clone +cd simpletodoapp +``` + +2. Create a virtual environment and activate it: + +```bash +python -m venv venv +source venv/bin/activate # On Windows: venv\Scripts\activate +``` + +3. Install the dependencies: + +```bash +pip install -r requirements.txt +``` + +## Database Setup + +The application uses SQLite for the database, and migrations are handled with Alembic. + +1. Run the migrations to set up the database: + +```bash +alembic upgrade head +``` + +## Running the Application + +To run the application: + +```bash +uvicorn main:app --reload +``` + +The API will be available at http://localhost:8000. + +## API Documentation + +After running the application, you can view the API documentation at: + +- Swagger UI: http://localhost:8000/docs +- ReDoc: http://localhost:8000/redoc + +## API Endpoints + +- `GET /api/todos/`: Get all todos +- `GET /api/todos/{todo_id}`: Get a specific todo +- `POST /api/todos/`: Create a new todo +- `PUT /api/todos/{todo_id}`: Update a todo +- `DELETE /api/todos/{todo_id}`: Delete a todo +- `GET /health`: Check the application health + +## License + +This project is licensed under the MIT License. diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..80b926f --- /dev/null +++ b/alembic.ini @@ -0,0 +1,110 @@ +# 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. + +# set to 'true' to search source files recursively +# in each "version_locations" directory +# new in Alembic version 1.10 +# recursive_version_locations = false + +# 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..2bcdea1 --- /dev/null +++ b/app/__init__.py @@ -0,0 +1 @@ +# This file is intentionally left empty to make the directory a Python package \ No newline at end of file diff --git a/app/api/__init__.py b/app/api/__init__.py new file mode 100644 index 0000000..2bcdea1 --- /dev/null +++ b/app/api/__init__.py @@ -0,0 +1 @@ +# This file is intentionally left empty to make the directory a Python package \ No newline at end of file diff --git a/app/api/routes.py b/app/api/routes.py new file mode 100644 index 0000000..a975722 --- /dev/null +++ b/app/api/routes.py @@ -0,0 +1,66 @@ +from fastapi import APIRouter, Depends, HTTPException, status, Response +from sqlalchemy.orm import Session +from typing import List + +from app.db.database import get_db +from app.schemas.todo import Todo, TodoCreate, TodoUpdate +from app.services.todo import ( + get_todos, + get_todo, + create_todo, + update_todo, + delete_todo, +) + +todo_router = APIRouter() +health_router = APIRouter() + + +@todo_router.get("/todos/", response_model=List[Todo]) +def read_todos(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): + """ + Retrieve all todos with pagination support. + """ + todos = get_todos(db, skip=skip, limit=limit) + return todos + + +@todo_router.get("/todos/{todo_id}", response_model=Todo) +def read_todo(todo_id: int, db: Session = Depends(get_db)): + """ + Retrieve a specific todo by ID. + """ + return get_todo(db, todo_id) + + +@todo_router.post("/todos/", response_model=Todo, status_code=status.HTTP_201_CREATED) +def create_todo_endpoint(todo: TodoCreate, db: Session = Depends(get_db)): + """ + Create a new todo. + """ + return create_todo(db, todo) + + +@todo_router.put("/todos/{todo_id}", response_model=Todo) +def update_todo_endpoint(todo_id: int, todo: TodoUpdate, db: Session = Depends(get_db)): + """ + Update an existing todo. + """ + return update_todo(db, todo_id, todo) + + +@todo_router.delete("/todos/{todo_id}", status_code=status.HTTP_204_NO_CONTENT) +def delete_todo_endpoint(todo_id: int, db: Session = Depends(get_db)): + """ + Delete a todo. + """ + delete_todo(db, todo_id) + return Response(status_code=status.HTTP_204_NO_CONTENT) + + +@health_router.get("/health") +def health_check(): + """ + Check the health of the application. + """ + return {"status": "healthy", "message": "Todo API is running"} \ No newline at end of file diff --git a/app/db/__init__.py b/app/db/__init__.py new file mode 100644 index 0000000..2bcdea1 --- /dev/null +++ b/app/db/__init__.py @@ -0,0 +1 @@ +# This file is intentionally left empty to make the directory a Python package \ No newline at end of file diff --git a/app/db/database.py b/app/db/database.py new file mode 100644 index 0000000..bc1c40a --- /dev/null +++ b/app/db/database.py @@ -0,0 +1,27 @@ +from sqlalchemy import create_engine +from sqlalchemy.ext.declarative import declarative_base +from sqlalchemy.orm import sessionmaker +from pathlib import Path + +# Create database directory +DB_DIR = Path("/app") / "storage" / "db" +DB_DIR.mkdir(parents=True, exist_ok=True) + +SQLALCHEMY_DATABASE_URL = f"sqlite:///{DB_DIR}/db.sqlite" + +engine = create_engine( + 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/db/models.py b/app/db/models.py new file mode 100644 index 0000000..ee01fb3 --- /dev/null +++ b/app/db/models.py @@ -0,0 +1,15 @@ +from sqlalchemy import Column, Integer, String, Boolean, DateTime +from sqlalchemy.sql import func + +from .database 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), server_default=func.now(), 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..2bcdea1 --- /dev/null +++ b/app/schemas/__init__.py @@ -0,0 +1 @@ +# This file is intentionally left empty to make the directory a Python package \ No newline at end of file diff --git a/app/schemas/todo.py b/app/schemas/todo.py new file mode 100644 index 0000000..d0de68c --- /dev/null +++ b/app/schemas/todo.py @@ -0,0 +1,28 @@ +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 Todo(TodoBase): + id: int + created_at: datetime + updated_at: datetime + + class Config: + from_attributes = True \ No newline at end of file diff --git a/app/services/__init__.py b/app/services/__init__.py new file mode 100644 index 0000000..2bcdea1 --- /dev/null +++ b/app/services/__init__.py @@ -0,0 +1 @@ +# This file is intentionally left empty to make the directory a Python package \ No newline at end of file diff --git a/app/services/todo.py b/app/services/todo.py new file mode 100644 index 0000000..f5c8caa --- /dev/null +++ b/app/services/todo.py @@ -0,0 +1,47 @@ +from sqlalchemy.orm import Session +from fastapi import HTTPException, status +from typing import List, Optional + +from app.db.models import Todo +from app.schemas.todo import TodoCreate, TodoUpdate + + +def get_todos(db: Session, skip: int = 0, limit: int = 100) -> List[Todo]: + return db.query(Todo).offset(skip).limit(limit).all() + + +def get_todo(db: Session, todo_id: int) -> Todo: + todo = db.query(Todo).filter(Todo.id == todo_id).first() + if todo is None: + raise HTTPException( + status_code=status.HTTP_404_NOT_FOUND, + detail=f"Todo with ID {todo_id} not found" + ) + return todo + + +def create_todo(db: Session, todo: TodoCreate) -> Todo: + db_todo = Todo(**todo.model_dump()) + db.add(db_todo) + db.commit() + db.refresh(db_todo) + return db_todo + + +def update_todo(db: Session, todo_id: int, todo_update: TodoUpdate) -> Todo: + db_todo = get_todo(db, todo_id) + + update_data = todo_update.model_dump(exclude_unset=True) + for key, value in update_data.items(): + setattr(db_todo, key, value) + + db.commit() + db.refresh(db_todo) + return db_todo + + +def delete_todo(db: Session, todo_id: int) -> None: + db_todo = get_todo(db, todo_id) + db.delete(db_todo) + db.commit() + return None \ No newline at end of file diff --git a/main.py b/main.py new file mode 100644 index 0000000..5a0744c --- /dev/null +++ b/main.py @@ -0,0 +1,23 @@ +import uvicorn +from fastapi import FastAPI +from pathlib import Path + +from app.api.routes import todo_router, health_router +from app.db.database import engine +from app.db.models import Base + +# Create database tables +Base.metadata.create_all(bind=engine) + +app = FastAPI( + title="Simple Todo App", + description="A simple Todo application built with FastAPI and SQLite", + version="0.1.0", +) + +# Include routers +app.include_router(todo_router, prefix="/api", 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/env.py b/migrations/env.py new file mode 100644 index 0000000..5777885 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,79 @@ +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) + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +from app.db.models import Base +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: + 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/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/1f87c1e94e6a_create_todos_table.py b/migrations/versions/1f87c1e94e6a_create_todos_table.py new file mode 100644 index 0000000..e58224f --- /dev/null +++ b/migrations/versions/1f87c1e94e6a_create_todos_table.py @@ -0,0 +1,36 @@ +"""create todos table + +Revision ID: 1f87c1e94e6a +Revises: +Create Date: 2025-05-13 00:00:00.000000 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '1f87c1e94e6a' +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(timezone=True), server_default=sa.text('(CURRENT_TIMESTAMP)'), nullable=False), + sa.Column('updated_at', sa.DateTime(timezone=True), server_default=sa.text('(CURRENT_TIMESTAMP)'), 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') \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..1864596 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,6 @@ +fastapi>=0.104.0 +uvicorn>=0.24.0 +sqlalchemy>=2.0.23 +alembic>=1.12.1 +pydantic>=2.4.2 +python-dotenv>=1.0.0 \ No newline at end of file