diff --git a/README.md b/README.md index e8acfba..ee3336c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,106 @@ -# FastAPI Application +# Simple Todo Application -This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform. +A simple todo application API built with FastAPI and SQLite. + +## Features + +- Create, read, update, and delete todo items +- Built with FastAPI for high performance +- SQLite database with SQLAlchemy ORM +- Alembic for database migrations +- Health check endpoint + +## Requirements + +- Python 3.8+ +- FastAPI +- SQLAlchemy +- Uvicorn +- Alembic +- Ruff + +## Installation + +1. Clone the repository: + +```bash +git clone +cd simpletodoapplication-ti5xsx +``` + +2. Install dependencies: + +```bash +pip install -r requirements.txt +``` + +## Usage + +1. Run the API server: + +```bash +python main.py +``` + +Or with uvicorn directly: + +```bash +uvicorn main:app --reload +``` + +2. Access the API documentation: + +- Swagger UI: http://localhost:8000/docs +- ReDoc: http://localhost:8000/redoc + +## API Endpoints + +### Health Check + +- `GET /health` - Check if the API is running + +### Todo 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 + +## Database Migrations + +This project uses Alembic for database migrations: + +```bash +# Apply migrations +alembic upgrade head + +# Create a new migration after model changes +alembic revision --autogenerate -m "Description of changes" +``` + +## Project Structure + +``` +simpletodoapplication-ti5xsx/ +├── alembic.ini +├── app/ +│ ├── __init__.py +│ ├── api/ +│ │ ├── __init__.py +│ │ └── routes.py +│ ├── db/ +│ │ ├── __init__.py +│ │ ├── database.py +│ │ └── models.py +│ └── schemas/ +│ ├── __init__.py +│ └── todo.py +├── main.py +├── migrations/ +│ ├── env.py +│ ├── script.py.mako +│ └── versions/ +│ └── 47fb0c1c35a0_initial_migration.py +└── requirements.txt +``` \ 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..318743e --- /dev/null +++ b/app/__init__.py @@ -0,0 +1 @@ +# App initialization \ No newline at end of file diff --git a/app/api/__init__.py b/app/api/__init__.py new file mode 100644 index 0000000..b0c27d8 --- /dev/null +++ b/app/api/__init__.py @@ -0,0 +1 @@ +# API module initialization \ No newline at end of file diff --git a/app/api/routes.py b/app/api/routes.py new file mode 100644 index 0000000..018eafa --- /dev/null +++ b/app/api/routes.py @@ -0,0 +1,72 @@ +from fastapi import APIRouter, Depends, HTTPException, status +from sqlalchemy.orm import Session +from typing import List + +from app.db.database import get_db +from app.db.models import Todo +from app.schemas.todo import TodoCreate, TodoResponse, TodoUpdate + +# Create routers +todo_router = APIRouter() +health_router = APIRouter() + + +@health_router.get("/health") +def health_check(): + """Health check endpoint""" + return {"status": "healthy"} + + +@todo_router.post("/todos/", response_model=TodoResponse, status_code=status.HTTP_201_CREATED) +def create_todo(todo: TodoCreate, db: Session = Depends(get_db)): + """Create a new todo item""" + 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 + + +@todo_router.get("/todos/", response_model=List[TodoResponse]) +def read_todos(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): + """Get all todo items""" + todos = db.query(Todo).offset(skip).limit(limit).all() + return todos + + +@todo_router.get("/todos/{todo_id}", response_model=TodoResponse) +def read_todo(todo_id: int, db: Session = Depends(get_db)): + """Get a specific todo item by ID""" + db_todo = db.query(Todo).filter(Todo.id == todo_id).first() + if db_todo is None: + raise HTTPException(status_code=404, detail="Todo not found") + return db_todo + + +@todo_router.put("/todos/{todo_id}", response_model=TodoResponse) +def update_todo(todo_id: int, todo: TodoUpdate, db: Session = Depends(get_db)): + """Update a todo item""" + db_todo = db.query(Todo).filter(Todo.id == todo_id).first() + if db_todo is None: + raise HTTPException(status_code=404, detail="Todo not found") + + # Update todo fields if they exist in the request + update_data = todo.dict(exclude_unset=True) + for key, value in update_data.items(): + setattr(db_todo, key, value) + + db.commit() + db.refresh(db_todo) + return db_todo + + +@todo_router.delete("/todos/{todo_id}", status_code=status.HTTP_204_NO_CONTENT) +def delete_todo(todo_id: int, db: Session = Depends(get_db)): + """Delete a todo item""" + db_todo = db.query(Todo).filter(Todo.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/db/__init__.py b/app/db/__init__.py new file mode 100644 index 0000000..74442bb --- /dev/null +++ b/app/db/__init__.py @@ -0,0 +1 @@ +# Database module initialization \ No newline at end of file diff --git a/app/db/database.py b/app/db/database.py new file mode 100644 index 0000000..b2773b9 --- /dev/null +++ b/app/db/database.py @@ -0,0 +1,27 @@ +from pathlib import Path +from sqlalchemy import create_engine +from sqlalchemy.ext.declarative import declarative_base +from sqlalchemy.orm import sessionmaker + +# 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 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/db/models.py b/app/db/models.py new file mode 100644 index 0000000..4b6bc28 --- /dev/null +++ b/app/db/models.py @@ -0,0 +1,17 @@ +from sqlalchemy import Boolean, Column, Integer, String, 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) + completed = Column(Boolean, default=False) + created_at = Column(DateTime(timezone=True), server_default=func.now()) + updated_at = Column(DateTime(timezone=True), onupdate=func.now()) + + def __repr__(self): + return f"" \ No newline at end of file diff --git a/app/schemas/__init__.py b/app/schemas/__init__.py new file mode 100644 index 0000000..943fa04 --- /dev/null +++ b/app/schemas/__init__.py @@ -0,0 +1 @@ +# Schemas module initialization \ No newline at end of file diff --git a/app/schemas/todo.py b/app/schemas/todo.py new file mode 100644 index 0000000..02eb99a --- /dev/null +++ b/app/schemas/todo.py @@ -0,0 +1,29 @@ +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 TodoResponse(TodoBase): + id: int + created_at: datetime + updated_at: Optional[datetime] = None + + class Config: + orm_mode = True + from_attributes = True \ No newline at end of file diff --git a/main.py b/main.py new file mode 100644 index 0000000..a57b302 --- /dev/null +++ b/main.py @@ -0,0 +1,21 @@ +import uvicorn +from fastapi import FastAPI +from app.api.routes import todo_router, health_router +from app.db.database import engine +from app.db import models + +# Create database tables if they don't exist +models.Base.metadata.create_all(bind=engine) + +app = FastAPI( + title="Simple Todo API", + description="A simple Todo API built with FastAPI and SQLite", + version="0.1.0" +) + +# Include routers +app.include_router(todo_router, prefix="/api/v1", 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) diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 0000000..3131e6a --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,80 @@ +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 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(): + """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, + render_as_batch=True + ) + + 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/47fb0c1c35a0_initial_migration.py b/migrations/versions/47fb0c1c35a0_initial_migration.py new file mode 100644 index 0000000..c0f2766 --- /dev/null +++ b/migrations/versions/47fb0c1c35a0_initial_migration.py @@ -0,0 +1,38 @@ +"""Initial migration + +Revision ID: 47fb0c1c35a0 +Revises: +Create Date: 2023-09-27 00:00:00.000000 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '47fb0c1c35a0' +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=True), + sa.Column('description', sa.String(), nullable=True), + sa.Column('completed', sa.Boolean(), default=False, nullable=True), + sa.Column('created_at', sa.DateTime(timezone=True), server_default=sa.func.now(), nullable=True), + 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/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..fc802cd --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,14 @@ +[tool.ruff] +target-version = "py38" +line-length = 100 +select = [ + "E", # pycodestyle errors + "F", # pyflakes + "I", # isort + "W", # pycodestyle warnings + "N", # pep8-naming +] +ignore = [] + +[tool.ruff.isort] +known-third-party = ["fastapi", "sqlalchemy", "pydantic", "alembic"] \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..eafc8c1 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,7 @@ +fastapi==0.103.1 +uvicorn==0.23.2 +sqlalchemy==2.0.20 +pydantic==2.3.0 +python-dotenv==1.0.0 +alembic==1.12.0 +ruff==0.0.290 \ No newline at end of file