diff --git a/README.md b/README.md index e8acfba..27b31d5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,112 @@ -# FastAPI Application +# Simple Todo App -This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform. +A simple Todo API built with FastAPI and SQLite. + +## Features + +- Create, read, update, and delete todo items +- Filter todos by completion status +- Health check endpoint for application status +- SQLite database with SQLAlchemy ORM +- API documentation with Swagger UI and ReDoc + +## Getting Started + +### Prerequisites + +- Python 3.7+ +- pip (Python package manager) + +### Installation + +1. Clone the repository: + +```bash +git clone +cd simpletodoapp-ev72zr +``` + +2. Install dependencies: + +```bash +pip install -r requirements.txt +``` + +3. Apply database migrations: + +```bash +alembic upgrade head +``` + +4. Start the development server: + +```bash +uvicorn main:app --reload +``` + +The API will be available at http://localhost:8000 + +## API Documentation + +After starting the server, you can access the API documentation at: + +- Swagger UI: http://localhost:8000/docs +- ReDoc: http://localhost:8000/redoc + +## API Endpoints + +### Todo Endpoints + +- **GET /api/v1/todos**: List all todos + - Query Parameters: + - `skip`: Number of records to skip (pagination) + - `limit`: Maximum number of records to return + - `completed`: Filter by completion status (true/false) + +- **POST /api/v1/todos**: Create a new todo + - Request Body: JSON with todo details + +- **GET /api/v1/todos/{todo_id}**: Get a specific todo by ID + +- **PUT /api/v1/todos/{todo_id}**: Update a specific todo + - Request Body: JSON with updated todo details + +- **DELETE /api/v1/todos/{todo_id}**: Delete a specific todo + +### Health Endpoint + +- **GET /api/v1/health**: Check the API health status + +## Project Structure + +``` +. +├── alembic.ini +├── app +│ ├── api +│ │ ├── endpoints +│ │ │ ├── health.py +│ │ │ └── todos.py +│ │ └── routes.py +│ ├── core +│ │ └── config.py +│ ├── db +│ │ ├── deps.py +│ │ └── session.py +│ ├── models +│ │ └── todo.py +│ └── schemas +│ └── todo.py +├── main.py +├── migrations +│ ├── README +│ ├── env.py +│ ├── script.py.mako +│ └── versions +│ └── 01_initial_setup.py +└── requirements.txt +``` + +## License + +This project is licensed under the MIT License. \ No newline at end of file diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..7c9d0f4 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,95 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = migrations + +# template used to generate migration files +# file_template = %%(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", i.e. directory separators. +# 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..bd737e1 --- /dev/null +++ b/app/__init__.py @@ -0,0 +1 @@ +# app 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..699e93e --- /dev/null +++ b/app/api/__init__.py @@ -0,0 +1 @@ +# api package \ 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..f7f8e53 --- /dev/null +++ b/app/api/endpoints/__init__.py @@ -0,0 +1 @@ +# endpoints package \ No newline at end of file diff --git a/app/api/endpoints/health.py b/app/api/endpoints/health.py new file mode 100644 index 0000000..ed51785 --- /dev/null +++ b/app/api/endpoints/health.py @@ -0,0 +1,28 @@ +from fastapi import APIRouter, Depends, status +from sqlalchemy.orm import Session +from sqlalchemy import text + +from app.core.config import settings +from app.db.deps import get_db + +router = APIRouter() + + +@router.get("/health", status_code=status.HTTP_200_OK) +def health_check(db: Session = Depends(get_db)): + """ + Health check endpoint for the application. + """ + # Check database connection + try: + db.execute(text("SELECT 1")) + db_status = "healthy" + except Exception: + db_status = "unhealthy" + + return { + "status": "healthy", + "app_name": settings.PROJECT_NAME, + "api_version": "v1", + "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..63677e0 --- /dev/null +++ b/app/api/endpoints/todos.py @@ -0,0 +1,96 @@ +from typing import List, Optional + +from fastapi import APIRouter, Depends, HTTPException, status +from sqlalchemy.orm import Session + +from app.db.deps import get_db +from app.models.todo import Todo as TodoModel +from app.schemas.todo import Todo, TodoCreate, TodoUpdate + +router = APIRouter() + + +@router.get("/", response_model=List[Todo]) +def read_todos( + db: Session = Depends(get_db), + skip: int = 0, + limit: int = 100, + completed: Optional[bool] = None +): + """ + Retrieve todos. + """ + if completed is not None: + todos = db.query(TodoModel).filter(TodoModel.completed == completed).offset(skip).limit(limit).all() + else: + todos = db.query(TodoModel).offset(skip).limit(limit).all() + 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. + """ + todo = TodoModel(**todo_in.model_dump()) + db.add(todo) + db.commit() + db.refresh(todo) + return todo + + +@router.get("/{todo_id}", response_model=Todo) +def read_todo( + todo_id: int, + db: Session = Depends(get_db) +): + """ + Get todo by ID. + """ + todo = db.query(TodoModel).filter(TodoModel.id == todo_id).first() + if todo is None: + raise HTTPException(status_code=404, detail="Todo not found") + return 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 = db.query(TodoModel).filter(TodoModel.id == todo_id).first() + if todo is None: + raise HTTPException(status_code=404, detail="Todo not found") + + update_data = todo_in.model_dump(exclude_unset=True) + for field, value in update_data.items(): + setattr(todo, field, value) + + db.add(todo) + db.commit() + db.refresh(todo) + return 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 = db.query(TodoModel).filter(TodoModel.id == todo_id).first() + if todo is None: + raise HTTPException(status_code=404, detail="Todo not found") + + db.delete(todo) + db.commit() + return None \ No newline at end of file diff --git a/app/api/routes.py b/app/api/routes.py new file mode 100644 index 0000000..1d66034 --- /dev/null +++ b/app/api/routes.py @@ -0,0 +1,7 @@ +from fastapi import APIRouter +from app.api.endpoints import todos, health + +router = APIRouter() + +router.include_router(todos.router, prefix="/todos", tags=["todos"]) +router.include_router(health.router, tags=["health"]) \ No newline at end of file diff --git a/app/core/__init__.py b/app/core/__init__.py new file mode 100644 index 0000000..5d9df9c --- /dev/null +++ b/app/core/__init__.py @@ -0,0 +1 @@ +# core package \ No newline at end of file diff --git a/app/core/config.py b/app/core/config.py new file mode 100644 index 0000000..3c9eb0f --- /dev/null +++ b/app/core/config.py @@ -0,0 +1,19 @@ +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 = Path("/app") / "storage" / "db" + + def __init__(self, **kwargs): + super().__init__(**kwargs) + self.DB_DIR.mkdir(parents=True, exist_ok=True) + + class Config: + env_file = ".env" + case_sensitive = True + +settings = Settings() \ No newline at end of file diff --git a/app/db/__init__.py b/app/db/__init__.py new file mode 100644 index 0000000..d337623 --- /dev/null +++ b/app/db/__init__.py @@ -0,0 +1 @@ +# db package \ No newline at end of file diff --git a/app/db/deps.py b/app/db/deps.py new file mode 100644 index 0000000..13ca911 --- /dev/null +++ b/app/db/deps.py @@ -0,0 +1,15 @@ +from typing import Generator + +from sqlalchemy.orm import Session + +from app.db.session import SessionLocal + +def get_db() -> Generator[Session, None, None]: + """ + Dependency for getting a database session. + """ + db = SessionLocal() + try: + yield db + finally: + db.close() \ No newline at end of file diff --git a/app/db/session.py b/app/db/session.py new file mode 100644 index 0000000..96a03cf --- /dev/null +++ b/app/db/session.py @@ -0,0 +1,19 @@ +from sqlalchemy import create_engine +from sqlalchemy.ext.declarative import declarative_base +from sqlalchemy.orm import sessionmaker + +from app.core.config import settings + +# Ensure the database directory exists +settings.DB_DIR.mkdir(parents=True, exist_ok=True) + +SQLALCHEMY_DATABASE_URL = f"sqlite:///{settings.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() \ No newline at end of file diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 0000000..afaccd6 --- /dev/null +++ b/app/models/__init__.py @@ -0,0 +1,2 @@ +# models package +from app.models.todo import Todo # noqa \ No newline at end of file diff --git a/app/models/todo.py b/app/models/todo.py new file mode 100644 index 0000000..4cb8e16 --- /dev/null +++ b/app/models/todo.py @@ -0,0 +1,14 @@ +from sqlalchemy import Boolean, Column, Integer, String, Text, DateTime +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(100), nullable=False) + description = Column(Text, 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..741f50f --- /dev/null +++ b/app/schemas/__init__.py @@ -0,0 +1,2 @@ +# schemas package +from app.schemas.todo import Todo, TodoCreate, TodoUpdate # noqa \ No newline at end of file diff --git a/app/schemas/todo.py b/app/schemas/todo.py new file mode 100644 index 0000000..99fdece --- /dev/null +++ b/app/schemas/todo.py @@ -0,0 +1,30 @@ +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] = None + completed: bool = False + +# Properties to receive via API on creation +class TodoCreate(TodoBase): + pass + +# Properties to receive via API on update +class TodoUpdate(BaseModel): + title: Optional[str] = Field(None, min_length=1, max_length=100) + description: Optional[str] = None + completed: Optional[bool] = None + +# Properties to return via API +class Todo(TodoBase): + id: int + created_at: datetime + updated_at: datetime + + 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..4fd4f4e --- /dev/null +++ b/main.py @@ -0,0 +1,16 @@ +import uvicorn +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 built with FastAPI and SQLite", + 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..7311333 --- /dev/null +++ b/migrations/README @@ -0,0 +1,6 @@ +Generic single-database configuration with SQLite. + +To run migrations: +1. Ensure alembic is installed: pip install alembic +2. Apply migrations: alembic upgrade head +3. Create a new migration: alembic revision -m "Description of changes" \ No newline at end of file diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 0000000..bd5227c --- /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 alembic import context +from app.db.session import Base +from app.models import todo # noqa + +# 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, # 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/01_initial_setup.py b/migrations/versions/01_initial_setup.py new file mode 100644 index 0000000..4ac57cd --- /dev/null +++ b/migrations/versions/01_initial_setup.py @@ -0,0 +1,37 @@ +"""Initial setup + +Revision ID: 01_initial_setup +Revises: +Create Date: 2023-08-01 10:00:00.000000 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '01_initial_setup' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade() -> None: + # Create todos table + op.create_table( + 'todos', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('title', sa.String(100), nullable=False), + sa.Column('description', sa.Text(), nullable=True), + sa.Column('completed', sa.Boolean(), nullable=False, default=False), + sa.Column('created_at', sa.DateTime(timezone=True), server_default=sa.func.now(), nullable=False), + sa.Column('updated_at', sa.DateTime(timezone=True), server_default=sa.func.now(), onupdate=sa.func.now(), nullable=False), + sa.PrimaryKeyConstraint('id') + ) + op.create_index(op.f('ix_todos_id'), 'todos', ['id'], unique=False) + + +def downgrade() -> None: + # Drop todos table + 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..cbc7c97 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,7 @@ +fastapi>=0.100.0 +uvicorn>=0.23.0 +sqlalchemy>=2.0.0 +alembic>=1.12.0 +pydantic>=2.0.0 +python-dotenv>=1.0.0 +ruff>=0.0.280 \ No newline at end of file