From 86a4793cced9d7afc2dbe3d9b18a04e4a887b385 Mon Sep 17 00:00:00 2001 From: Automated Action Date: Tue, 13 May 2025 10:15:27 +0000 Subject: [PATCH] Enhance FastAPI application setup - Added environment variable support via .env file - Updated API routes with versioning prefix - Improved documentation in README - Enhanced SQLite database path configuration generated with BackendIM... (backend.im) --- README.md | 86 +++++++++++++++++- alembic.ini | 85 ++++++++++++++++++ alembic/README | 1 + alembic/env.py | 83 ++++++++++++++++++ alembic/script.py.mako | 24 +++++ .../versions/12345678_create_todo_table.py | 38 ++++++++ app/__init__.py | 0 app/api/__init__.py | 0 app/api/deps.py | 6 ++ app/api/routes.py | 7 ++ app/api/v1/__init__.py | 0 app/api/v1/endpoints/__init__.py | 0 app/api/v1/endpoints/todos.py | 87 +++++++++++++++++++ app/core/__init__.py | 0 app/core/config.py | 17 ++++ app/crud/__init__.py | 0 app/crud/base.py | 66 ++++++++++++++ app/crud/crud_todo.py | 23 +++++ app/db/__init__.py | 0 app/db/base.py | 4 + app/db/base_class.py | 13 +++ app/db/session.py | 18 ++++ app/models/__init__.py | 0 app/models/todo.py | 13 +++ app/schemas/__init__.py | 0 app/schemas/todo.py | 37 ++++++++ main.py | 17 ++++ requirements.txt | 7 ++ 28 files changed, 630 insertions(+), 2 deletions(-) create mode 100644 alembic.ini create mode 100644 alembic/README create mode 100644 alembic/env.py create mode 100644 alembic/script.py.mako create mode 100644 alembic/versions/12345678_create_todo_table.py create mode 100644 app/__init__.py create mode 100644 app/api/__init__.py create mode 100644 app/api/deps.py create mode 100644 app/api/routes.py create mode 100644 app/api/v1/__init__.py create mode 100644 app/api/v1/endpoints/__init__.py create mode 100644 app/api/v1/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/base.py create mode 100644 app/crud/crud_todo.py create mode 100644 app/db/__init__.py create mode 100644 app/db/base.py create mode 100644 app/db/base_class.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 requirements.txt diff --git a/README.md b/README.md index e8acfba..51f1112 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,85 @@ -# 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 +- Filter todos by completion status +- RESTful API with OpenAPI documentation +- SQLite database with SQLAlchemy ORM +- Alembic for database migrations +- Environment variable configuration support + +## Project Structure + +``` +. +├── alembic/ # Database migration scripts +├── app/ # Application code +│ ├── api/ # API endpoints +│ │ ├── v1/ # API version 1 +│ │ │ └── endpoints/ # API endpoints +│ ├── core/ # Core application code +│ ├── crud/ # CRUD operations +│ ├── db/ # Database setup +│ ├── models/ # SQLAlchemy models +│ └── schemas/ # Pydantic schemas +├── main.py # Application entry point +├── alembic.ini # Alembic configuration +└── requirements.txt # Dependencies +``` + +## Installation + +1. Clone the repository: + +```bash +git clone https://github.com/yourusername/simpletodoapp.git +cd simpletodoapp +``` + +2. Install dependencies: + +```bash +pip install -r requirements.txt +``` + +3. Configure environment variables (optional): + Create a `.env` file with your configuration options + +4. Run database migrations: + +```bash +alembic upgrade head +``` + +## Usage + +1. Start the server: + +```bash +uvicorn main:app --reload +``` + +2. Access the API documentation at: + - Swagger UI: http://localhost:8000/docs + - ReDoc: http://localhost:8000/redoc + +## API Endpoints + +All API endpoints are prefixed with `/api/v1` + +- `GET /api/v1/todos`: Get all todos +- `GET /api/v1/todos/{id}`: Get a specific todo +- `POST /api/v1/todos`: Create a new todo +- `PUT /api/v1/todos/{id}`: Update a todo +- `DELETE /api/v1/todos/{id}`: Delete a todo + +## Health Check + +- `GET /health`: Health check endpoint + +## License + +MIT \ No newline at end of file diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..2e9f704 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,85 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = alembic + +# template used to generate migration files +# file_template = %%(rev)s_%%(slug)s + +# timezone to use when rendering the date +# within the migration file as well as the filename. +# 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 alembic/versions. When using multiple version +# directories, initial revisions must be specified with --version-path +# version_locations = %(here)s/bar %(here)s/bat alembic/versions + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +sqlalchemy.url = driver://user:pass@localhost/dbname + + +[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 + +# 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/alembic/README b/alembic/README new file mode 100644 index 0000000..98e4f9c --- /dev/null +++ b/alembic/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/alembic/env.py b/alembic/env.py new file mode 100644 index 0000000..a800382 --- /dev/null +++ b/alembic/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. +fileConfig(config.config_file_name) + +# add your model's MetaData object here +# for 'autogenerate' support +from app.db.base import Base # noqa +target_metadata = Base.metadata + +# Import all models for Alembic autogenerate +from app.models.todo import Todo # noqa + +# 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. + +from app.core.config import settings + +config.set_main_option("sqlalchemy.url", settings.SQLALCHEMY_DATABASE_URL) + + +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 + ) + + 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/alembic/script.py.mako b/alembic/script.py.mako new file mode 100644 index 0000000..1e4564e --- /dev/null +++ b/alembic/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/alembic/versions/12345678_create_todo_table.py b/alembic/versions/12345678_create_todo_table.py new file mode 100644 index 0000000..49f0bf4 --- /dev/null +++ b/alembic/versions/12345678_create_todo_table.py @@ -0,0 +1,38 @@ +"""create todo table + +Revision ID: 12345678 +Revises: +Create Date: 2025-05-13 + +""" +from alembic import op +import sqlalchemy as sa +from sqlalchemy.sql import func + + +# revision identifiers, used by Alembic. +revision = '12345678' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + op.create_table( + 'todo', + 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(), default=False), + sa.Column('created_at', sa.DateTime(timezone=True), server_default=func.now()), + sa.Column('updated_at', sa.DateTime(timezone=True), onupdate=func.now()), + sa.PrimaryKeyConstraint('id') + ) + op.create_index(op.f('ix_todo_id'), 'todo', ['id'], unique=False) + op.create_index(op.f('ix_todo_title'), 'todo', ['title'], unique=False) + + +def downgrade(): + op.drop_index(op.f('ix_todo_title'), table_name='todo') + op.drop_index(op.f('ix_todo_id'), table_name='todo') + op.drop_table('todo') \ 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/deps.py b/app/api/deps.py new file mode 100644 index 0000000..7324b2c --- /dev/null +++ b/app/api/deps.py @@ -0,0 +1,6 @@ +from typing import Generator + +from fastapi import Depends +from sqlalchemy.orm import Session + +from app.db.session import get_db \ No newline at end of file diff --git a/app/api/routes.py b/app/api/routes.py new file mode 100644 index 0000000..efdc4cb --- /dev/null +++ b/app/api/routes.py @@ -0,0 +1,7 @@ +from fastapi import APIRouter + +from app.api.v1.endpoints import todos +from app.core.config import settings + +router = APIRouter() +router.include_router(todos.router, prefix="/todos", tags=["todos"]) \ No newline at end of file diff --git a/app/api/v1/__init__.py b/app/api/v1/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/api/v1/endpoints/__init__.py b/app/api/v1/endpoints/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/api/v1/endpoints/todos.py b/app/api/v1/endpoints/todos.py new file mode 100644 index 0000000..6cf8388 --- /dev/null +++ b/app/api/v1/endpoints/todos.py @@ -0,0 +1,87 @@ +from typing import Any, List, Optional + +from fastapi import APIRouter, Depends, HTTPException, Query +from sqlalchemy.orm import Session + +from app import crud, models, schemas +from app.api.deps import get_db +from app.crud.crud_todo import todo + +router = APIRouter() + + +@router.get("/", response_model=List[schemas.Todo]) +def read_todos( + db: Session = Depends(get_db), + skip: int = 0, + limit: int = 100, + completed: Optional[bool] = None, +) -> Any: + """ + Retrieve todos. + """ + if completed is not None: + todos = todo.get_multi_by_completion(db, completed=completed, skip=skip, limit=limit) + else: + todos = todo.get_multi(db, skip=skip, limit=limit) + return todos + + +@router.post("/", response_model=schemas.Todo) +def create_todo( + *, + db: Session = Depends(get_db), + todo_in: schemas.TodoCreate, +) -> Any: + """ + Create new todo. + """ + return todo.create(db=db, obj_in=todo_in) + + +@router.get("/{id}", response_model=schemas.Todo) +def read_todo( + *, + db: Session = Depends(get_db), + id: int, +) -> Any: + """ + Get todo by ID. + """ + todo_item = todo.get(db=db, id=id) + if not todo_item: + raise HTTPException(status_code=404, detail="Todo not found") + return todo_item + + +@router.put("/{id}", response_model=schemas.Todo) +def update_todo( + *, + db: Session = Depends(get_db), + id: int, + todo_in: schemas.TodoUpdate, +) -> Any: + """ + Update a todo. + """ + todo_item = todo.get(db=db, id=id) + if not todo_item: + raise HTTPException(status_code=404, detail="Todo not found") + todo_item = todo.update(db=db, db_obj=todo_item, obj_in=todo_in) + return todo_item + + +@router.delete("/{id}", response_model=schemas.Todo) +def delete_todo( + *, + db: Session = Depends(get_db), + id: int, +) -> Any: + """ + Delete a todo. + """ + todo_item = todo.get(db=db, id=id) + if not todo_item: + raise HTTPException(status_code=404, detail="Todo not found") + todo_item = todo.remove(db=db, id=id) + return todo_item \ 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..356ccfa --- /dev/null +++ b/app/core/config.py @@ -0,0 +1,17 @@ +from pathlib import Path +from pydantic_settings import BaseSettings + +class Settings(BaseSettings): + PROJECT_NAME: str = "Simple Todo App" + API_V1_STR: str = "/api/v1" + + # Database + 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() \ No newline at end of file diff --git a/app/crud/__init__.py b/app/crud/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/crud/base.py b/app/crud/base.py new file mode 100644 index 0000000..071c859 --- /dev/null +++ b/app/crud/base.py @@ -0,0 +1,66 @@ +from typing import Any, Dict, Generic, List, Optional, Type, TypeVar, Union + +from fastapi.encoders import jsonable_encoder +from pydantic import BaseModel +from sqlalchemy.orm import Session + +from app.db.base_class import Base + +ModelType = TypeVar("ModelType", bound=Base) +CreateSchemaType = TypeVar("CreateSchemaType", bound=BaseModel) +UpdateSchemaType = TypeVar("UpdateSchemaType", bound=BaseModel) + + +class CRUDBase(Generic[ModelType, CreateSchemaType, UpdateSchemaType]): + def __init__(self, model: Type[ModelType]): + """ + CRUD object with default methods to Create, Read, Update, Delete (CRUD). + + **Parameters** + + * `model`: A SQLAlchemy model class + * `schema`: A Pydantic model (schema) class + """ + self.model = model + + def get(self, db: Session, id: Any) -> Optional[ModelType]: + return db.query(self.model).filter(self.model.id == id).first() + + def get_multi( + self, db: Session, *, skip: int = 0, limit: int = 100 + ) -> List[ModelType]: + return db.query(self.model).offset(skip).limit(limit).all() + + def create(self, db: Session, *, obj_in: CreateSchemaType) -> ModelType: + obj_in_data = jsonable_encoder(obj_in) + db_obj = self.model(**obj_in_data) + db.add(db_obj) + db.commit() + db.refresh(db_obj) + return db_obj + + def update( + self, + db: Session, + *, + db_obj: ModelType, + obj_in: Union[UpdateSchemaType, Dict[str, Any]] + ) -> ModelType: + obj_data = jsonable_encoder(db_obj) + if isinstance(obj_in, dict): + update_data = obj_in + else: + update_data = obj_in.dict(exclude_unset=True) + for field in obj_data: + if field in update_data: + setattr(db_obj, field, update_data[field]) + db.add(db_obj) + db.commit() + db.refresh(db_obj) + return db_obj + + def remove(self, db: Session, *, id: int) -> ModelType: + obj = db.query(self.model).get(id) + db.delete(obj) + db.commit() + return obj \ 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..3609763 --- /dev/null +++ b/app/crud/crud_todo.py @@ -0,0 +1,23 @@ +from typing import List, Optional + +from sqlalchemy.orm import Session + +from app.crud.base import CRUDBase +from app.models.todo import Todo +from app.schemas.todo import TodoCreate, TodoUpdate + + +class CRUDTodo(CRUDBase[Todo, TodoCreate, TodoUpdate]): + def get_multi_by_completion( + self, db: Session, *, completed: bool, skip: int = 0, limit: int = 100 + ) -> List[Todo]: + return ( + db.query(self.model) + .filter(Todo.completed == completed) + .offset(skip) + .limit(limit) + .all() + ) + + +todo = CRUDTodo(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/base.py b/app/db/base.py new file mode 100644 index 0000000..379f09b --- /dev/null +++ b/app/db/base.py @@ -0,0 +1,4 @@ +# Import all the models, so that Base has them before being +# imported by Alembic +from app.db.base_class import Base # noqa +from app.models.todo import Todo # noqa \ No newline at end of file diff --git a/app/db/base_class.py b/app/db/base_class.py new file mode 100644 index 0000000..df4bcda --- /dev/null +++ b/app/db/base_class.py @@ -0,0 +1,13 @@ +from typing import Any +from sqlalchemy.ext.declarative import as_declarative, declared_attr + + +@as_declarative() +class Base: + id: Any + __name__: str + + # Generate __tablename__ automatically + @declared_attr + def __tablename__(cls) -> str: + return cls.__name__.lower() \ No newline at end of file diff --git a/app/db/session.py b/app/db/session.py new file mode 100644 index 0000000..24b55ec --- /dev/null +++ b/app/db/session.py @@ -0,0 +1,18 @@ +from sqlalchemy import create_engine +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) + + +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..a7f0db5 --- /dev/null +++ b/app/models/todo.py @@ -0,0 +1,13 @@ +from sqlalchemy import Column, Integer, String, Boolean, DateTime +from sqlalchemy.sql import func + +from app.db.base_class import Base + + +class Todo(Base): + 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..e66ba53 --- /dev/null +++ b/app/schemas/todo.py @@ -0,0 +1,37 @@ +from datetime import datetime +from typing import Optional + +from pydantic import BaseModel + + +# Shared properties +class TodoBase(BaseModel): + title: str + description: Optional[str] = None + completed: bool = False + + +# Properties to receive on item creation +class TodoCreate(TodoBase): + pass + + +# Properties to receive on item update +class TodoUpdate(TodoBase): + title: Optional[str] = None + completed: Optional[bool] = None + + +# Properties shared by models stored in DB +class TodoInDBBase(TodoBase): + id: int + created_at: datetime + updated_at: Optional[datetime] = None + + class Config: + orm_mode = 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..50c6a53 --- /dev/null +++ b/main.py @@ -0,0 +1,17 @@ +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, + openapi_url=f"{settings.API_V1_STR}/openapi.json", + docs_url="/docs", + redoc_url="/redoc" +) + +# Include API router with the version prefix +app.include_router(api_router, prefix=settings.API_V1_STR) + +@app.get("/health", tags=["health"]) +async def health_check(): + return {"status": "ok"} \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..959cc46 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,7 @@ +fastapi==0.109.0 +uvicorn==0.25.0 +sqlalchemy==2.0.25 +alembic==1.13.1 +pydantic==2.5.3 +pydantic-settings==2.1.0 +python-dotenv==1.0.0 \ No newline at end of file