From db2997cc83a0ac8efe8e666fd74b11b18a8d2b52 Mon Sep 17 00:00:00 2001 From: Automated Action Date: Sun, 11 May 2025 16:39:38 +0000 Subject: [PATCH] Create FastAPI todo backend with SQLite Generated with and Co-Authored by [BackendIM](https://backend.im) --- README.md | 58 +++++++++++- alembic.ini | 100 +++++++++++++++++++++ alembic/env.py | 78 ++++++++++++++++ alembic/script.py.mako | 24 +++++ alembic/versions/0001_create_todo_table.py | 33 +++++++ app/__init__.py | 0 app/api/__init__.py | 0 app/api/api_v1/__init__.py | 0 app/api/api_v1/api.py | 6 ++ app/api/api_v1/endpoints/todos.py | 83 +++++++++++++++++ app/api/deps.py | 13 +++ app/core/config.py | 13 +++ app/crud/__init__.py | 1 + app/crud/base.py | 61 +++++++++++++ app/crud/crud_todo.py | 15 ++++ app/db/__init__.py | 0 app/db/base.py | 4 + app/db/base_class.py | 12 +++ app/db/session.py | 18 ++++ app/models/__init__.py | 1 + app/models/todo.py | 15 ++++ app/schemas/__init__.py | 1 + app/schemas/todo.py | 36 ++++++++ main.py | 25 ++++++ requirements.txt | 6 ++ 25 files changed, 601 insertions(+), 2 deletions(-) create mode 100644 alembic.ini create mode 100644 alembic/env.py create mode 100644 alembic/script.py.mako create mode 100644 alembic/versions/0001_create_todo_table.py create mode 100644 app/__init__.py create mode 100644 app/api/__init__.py create mode 100644 app/api/api_v1/__init__.py create mode 100644 app/api/api_v1/api.py create mode 100644 app/api/api_v1/endpoints/todos.py create mode 100644 app/api/deps.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..7c36d73 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,57 @@ -# FastAPI Application +# Todo Backend Service -This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform. +A simple Todo API built with FastAPI and SQLite. + +## Features + +- Todo CRUD operations +- RESTful API design +- SQLite database with SQLAlchemy ORM +- Alembic for database migrations + +## Requirements + +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 +``` + +## Running the Application + +```bash +uvicorn main:app --reload +``` + +The API will be available at http://localhost:8000 + +Swagger documentation is available at http://localhost:8000/docs + +## API Endpoints + +| Method | URL | Description | +| ------ | --- | ----------- | +| GET | /api/v1/todos | Get all todos | +| GET | /api/v1/todos/{id} | Get a todo by id | +| POST | /api/v1/todos | Create a new todo | +| PUT | /api/v1/todos/{id} | Update a todo | +| DELETE | /api/v1/todos/{id} | Delete a todo | + +## Example JSON Payload for Creating a Todo + +```json +{ + "title": "Buy groceries", + "description": "Milk, eggs, bread", + "completed": false +} +``` \ No newline at end of file diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..d1ab580 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,100 @@ +# 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 + +# 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 alembic/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" +# version_locations = %(here)s/bar:%(here)s/bat:alembic/versions + +# version path separator; As mentioned above, this is the character used to split +# version_locations. Valid values are: +# +# version_path_separator = : +# version_path_separator = ; +# version_path_separator = space +version_path_separator = os # default: use os.pathsep + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +sqlalchemy.url = sqlite:///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/alembic/env.py b/alembic/env.py new file mode 100644 index 0000000..3566b89 --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,78 @@ +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.base 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 + ) + + 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/0001_create_todo_table.py b/alembic/versions/0001_create_todo_table.py new file mode 100644 index 0000000..556fd45 --- /dev/null +++ b/alembic/versions/0001_create_todo_table.py @@ -0,0 +1,33 @@ +"""create todo table + +Revision ID: 0001 +Revises: +Create Date: 2023-01-01 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '0001' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + 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), onupdate=sa.func.now()), + sa.PrimaryKeyConstraint('id') + ) + + +def downgrade(): + op.drop_table('todos') \ 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_v1/__init__.py b/app/api/api_v1/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/api/api_v1/api.py b/app/api/api_v1/api.py new file mode 100644 index 0000000..8c02b48 --- /dev/null +++ b/app/api/api_v1/api.py @@ -0,0 +1,6 @@ +from fastapi import APIRouter + +from app.api.api_v1.endpoints import todos + +api_router = APIRouter() +api_router.include_router(todos.router, prefix="/todos", tags=["todos"]) \ No newline at end of file diff --git a/app/api/api_v1/endpoints/todos.py b/app/api/api_v1/endpoints/todos.py new file mode 100644 index 0000000..18748a5 --- /dev/null +++ b/app/api/api_v1/endpoints/todos.py @@ -0,0 +1,83 @@ +from typing import Any, List + +from fastapi import APIRouter, Depends, HTTPException +from sqlalchemy.orm import Session + +from app import crud, schemas +from app.api import deps + +router = APIRouter() + + +@router.get("/", response_model=List[schemas.Todo]) +def read_todos( + db: Session = Depends(deps.get_db), + skip: int = 0, + limit: int = 100, +) -> Any: + """ + Retrieve todos. + """ + todos = crud.todo.get_multi(db, skip=skip, limit=limit) + return todos + + +@router.post("/", response_model=schemas.Todo) +def create_todo( + *, + db: Session = Depends(deps.get_db), + todo_in: schemas.TodoCreate, +) -> Any: + """ + Create new todo. + """ + todo = crud.todo.create(db=db, obj_in=todo_in) + return todo + + +@router.get("/{id}", response_model=schemas.Todo) +def read_todo( + *, + db: Session = Depends(deps.get_db), + id: int, +) -> Any: + """ + Get todo by ID. + """ + todo = crud.todo.get(db=db, id=id) + if not todo: + raise HTTPException(status_code=404, detail="Todo not found") + return todo + + +@router.put("/{id}", response_model=schemas.Todo) +def update_todo( + *, + db: Session = Depends(deps.get_db), + id: int, + todo_in: schemas.TodoUpdate, +) -> Any: + """ + Update a todo. + """ + todo = crud.todo.get(db=db, id=id) + if not todo: + raise HTTPException(status_code=404, detail="Todo not found") + todo = crud.todo.update(db=db, db_obj=todo, obj_in=todo_in) + return todo + + +@router.delete("/{id}", response_model=schemas.Todo) +def delete_todo( + *, + db: Session = Depends(deps.get_db), + id: int, +) -> Any: + """ + Delete a todo. + """ + todo = crud.todo.get(db=db, id=id) + if not todo: + raise HTTPException(status_code=404, detail="Todo not found") + todo = crud.todo.remove(db=db, id=id) + return todo \ No newline at end of file diff --git a/app/api/deps.py b/app/api/deps.py new file mode 100644 index 0000000..65db020 --- /dev/null +++ b/app/api/deps.py @@ -0,0 +1,13 @@ +from typing import Generator + +from sqlalchemy.orm import Session + +from app.db.session import SessionLocal + + +def get_db() -> Generator: + try: + db = SessionLocal() + yield db + finally: + db.close() \ No newline at end of file diff --git a/app/core/config.py b/app/core/config.py new file mode 100644 index 0000000..d5b69da --- /dev/null +++ b/app/core/config.py @@ -0,0 +1,13 @@ +from pydantic import BaseSettings +from typing import Optional + + +class Settings(BaseSettings): + API_V1_STR: str = "/api/v1" + PROJECT_NAME: str = "Todo Backend Service" + + class Config: + 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..7a5658b --- /dev/null +++ b/app/crud/__init__.py @@ -0,0 +1 @@ +from app.crud.crud_todo import todo # noqa \ No newline at end of file diff --git a/app/crud/base.py b/app/crud/base.py new file mode 100644 index 0000000..86da7f2 --- /dev/null +++ b/app/crud/base.py @@ -0,0 +1,61 @@ +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). + """ + 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..f3990ed --- /dev/null +++ b/app/crud/crud_todo.py @@ -0,0 +1,15 @@ +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_by_title(self, db: Session, *, title: str) -> Optional[Todo]: + return db.query(Todo).filter(Todo.title == title).first() + + +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..5f1c3de --- /dev/null +++ b/app/db/base_class.py @@ -0,0 +1,12 @@ +from typing import Any +from sqlalchemy.ext.declarative import as_declarative, declared_attr + + +@as_declarative() +class Base: + id: Any + __name__: str + + @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..2351e96 --- /dev/null +++ b/app/db/session.py @@ -0,0 +1,18 @@ +from sqlalchemy import create_engine +from sqlalchemy.ext.declarative import declarative_base +from sqlalchemy.orm import sessionmaker +from pathlib import Path + +BASE_DIR = Path(__file__).resolve().parent.parent.parent +DB_DIR = BASE_DIR / "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() \ No newline at end of file diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 0000000..6c7f9b5 --- /dev/null +++ b/app/models/__init__.py @@ -0,0 +1 @@ +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..c1ed45f --- /dev/null +++ b/app/models/todo.py @@ -0,0 +1,15 @@ +from sqlalchemy import Column, Integer, String, Boolean, DateTime +from sqlalchemy.sql import func + +from app.db.base_class 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..182cb5f --- /dev/null +++ b/app/schemas/__init__.py @@ -0,0 +1 @@ +from app.schemas.todo import TodoCreate, TodoUpdate, Todo # 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..724c5af --- /dev/null +++ b/app/schemas/todo.py @@ -0,0 +1,36 @@ +from typing import Optional +from datetime import datetime +from pydantic import BaseModel + + +# Shared properties +class TodoBase(BaseModel): + title: str + description: Optional[str] = None + completed: bool = False + + +# Properties to receive on todo creation +class TodoCreate(TodoBase): + pass + + +# Properties to receive on todo 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..da8172e --- /dev/null +++ b/main.py @@ -0,0 +1,25 @@ +from fastapi import FastAPI +from fastapi.middleware.cors import CORSMiddleware + +from app.api.api_v1.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" +) + +# Set all CORS enabled origins +app.add_middleware( + CORSMiddleware, + allow_origins=["*"], + allow_credentials=True, + allow_methods=["*"], + allow_headers=["*"], +) + +app.include_router(api_router, prefix=settings.API_V1_STR) + +if __name__ == "__main__": + import uvicorn + uvicorn.run("main:app", host="0.0.0.0", port=8000, reload=True) \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..8f53552 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,6 @@ +fastapi>=0.68.0,<0.69.0 +pydantic>=1.8.0,<2.0.0 +uvicorn>=0.15.0,<0.16.0 +sqlalchemy>=1.4.0,<1.5.0 +alembic>=1.6.5,<1.7.0 +python-dotenv>=0.19.0,<0.20.0 \ No newline at end of file