diff --git a/README.md b/README.md index e8acfba..e039bbe 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,95 @@ -# FastAPI Application +# FastAPI Todo Application -This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform. +This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform. The application provides a RESTful API for managing todo items. + +## Features + +- RESTful API for CRUD operations on todo items +- FastAPI with automatic API documentation +- SQLite database with SQLAlchemy ORM +- Alembic for database migrations +- Health check endpoint +- CORS support + +## Project Structure + +``` +todoapp/ +├── alembic.ini +├── app/ +│ ├── __init__.py +│ ├── api/ +│ │ ├── __init__.py +│ │ └── v1/ +│ │ ├── __init__.py +│ │ ├── api.py +│ │ ├── health.py +│ │ └── todos.py +│ ├── core/ +│ │ ├── config.py +│ │ └── database.py +│ ├── models/ +│ │ ├── __init__.py +│ │ └── todo.py +│ └── schemas/ +│ ├── __init__.py +│ └── todo.py +├── main.py +├── migrations/ +│ ├── README +│ ├── env.py +│ ├── script.py.mako +│ └── versions/ +│ └── 9c42f1a4a5a7_create_todos_table.py +└── requirements.txt +``` + +## Installation + +1. Clone the repository: + +```bash +git clone +cd todoapp +``` + +2. Install dependencies: + +```bash +pip install -r requirements.txt +``` + +3. Run migrations to create the database: + +```bash +alembic upgrade head +``` + +## Running the Application + +Start the application with: + +```bash +uvicorn main:app --host 0.0.0.0 --port 8000 --reload +``` + +The API will be available at http://localhost:8000. You can access the API documentation at http://localhost:8000/docs. + +## API 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 specific todo +- **DELETE /api/v1/todos/{todo_id}**: Delete a specific todo +- **GET /health**: Health check endpoint + +## Development + +- The database is stored at `/app/storage/db/db.sqlite` +- Use Alembic to manage database migrations +- The API has CORS enabled for development purposes + +## License + +MIT \ No newline at end of file diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..634a012 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,85 @@ +# 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 + +# 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 migrations/versions. When using multiple version +# directories, initial revisions must be specified with --version-path +# version_locations = %(here)s/bar %(here)s/bat migrations/versions + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +# SQLite URL example +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 + +# 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..1376405 --- /dev/null +++ b/app/__init__.py @@ -0,0 +1 @@ +# app module 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..8c7d813 --- /dev/null +++ b/app/api/__init__.py @@ -0,0 +1 @@ +# api module initialization \ 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..3496d27 --- /dev/null +++ b/app/api/v1/__init__.py @@ -0,0 +1 @@ +# api v1 module initialization \ No newline at end of file diff --git a/app/api/v1/api.py b/app/api/v1/api.py new file mode 100644 index 0000000..e72d843 --- /dev/null +++ b/app/api/v1/api.py @@ -0,0 +1,7 @@ +from fastapi import APIRouter + +from app.api.v1 import health, todos + +api_router = APIRouter() +api_router.include_router(health.router, tags=["health"]) +api_router.include_router(todos.router, prefix="/todos", tags=["todos"]) \ No newline at end of file diff --git a/app/api/v1/health.py b/app/api/v1/health.py new file mode 100644 index 0000000..58bc46d --- /dev/null +++ b/app/api/v1/health.py @@ -0,0 +1,11 @@ +from fastapi import APIRouter, status + +router = APIRouter() + + +@router.get("/health", status_code=status.HTTP_200_OK) +def health_check(): + """ + Health check endpoint to verify API is running. + """ + return {"status": "ok"} \ No newline at end of file diff --git a/app/api/v1/todos.py b/app/api/v1/todos.py new file mode 100644 index 0000000..f9046b0 --- /dev/null +++ b/app/api/v1/todos.py @@ -0,0 +1,79 @@ +from typing import List + +from fastapi import APIRouter, Depends, HTTPException, status +from sqlalchemy.orm import Session + +from app.core.database 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( + skip: int = 0, limit: int = 100, db: Session = Depends(get_db) +): + """ + Retrieve all todos. + """ + 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: TodoCreate, db: Session = Depends(get_db)): + """ + Create a new todo. + """ + db_todo = TodoModel(**todo.dict()) + db.add(db_todo) + db.commit() + db.refresh(db_todo) + return db_todo + + +@router.get("/{todo_id}", response_model=Todo) +def read_todo(todo_id: int, db: Session = Depends(get_db)): + """ + Retrieve a specific todo by id. + """ + db_todo = db.query(TodoModel).filter(TodoModel.id == todo_id).first() + if db_todo is None: + raise HTTPException(status_code=404, detail="Todo not found") + return db_todo + + +@router.put("/{todo_id}", response_model=Todo) +def update_todo( + todo_id: int, todo: TodoUpdate, db: Session = Depends(get_db) +): + """ + Update a specific todo by id. + """ + db_todo = db.query(TodoModel).filter(TodoModel.id == todo_id).first() + if db_todo is None: + raise HTTPException(status_code=404, detail="Todo not found") + + update_data = todo.dict(exclude_unset=True) + for key, value in update_data.items(): + setattr(db_todo, key, value) + + db.add(db_todo) + db.commit() + db.refresh(db_todo) + return db_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 specific todo by id. + """ + db_todo = db.query(TodoModel).filter(TodoModel.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/core/config.py b/app/core/config.py new file mode 100644 index 0000000..7a3adc5 --- /dev/null +++ b/app/core/config.py @@ -0,0 +1,30 @@ +from pathlib import Path +from typing import List, Union + +from pydantic import AnyHttpUrl, BaseSettings, validator + + +class Settings(BaseSettings): + API_V1_STR: str = "/api/v1" + # BACKEND_CORS_ORIGINS is a JSON-formatted list of origins + # e.g: '["http://localhost", "http://localhost:4200", "http://localhost:3000", \ + # "http://localhost:8080"]' + BACKEND_CORS_ORIGINS: List[AnyHttpUrl] = [] + + @validator("BACKEND_CORS_ORIGINS", pre=True) + def assemble_cors_origins(cls, v: Union[str, List[str]]) -> Union[List[str], str]: + if isinstance(v, str) and not v.startswith("["): + return [i.strip() for i in v.split(",")] + elif isinstance(v, (list, str)): + return v + raise ValueError(v) + + PROJECT_NAME: str = "Todo App API" + + # Database + DB_DIR = Path("/app") / "storage" / "db" + DB_DIR.mkdir(parents=True, exist_ok=True) + SQLALCHEMY_DATABASE_URL = f"sqlite:///{DB_DIR}/db.sqlite" + + +settings = Settings() \ No newline at end of file diff --git a/app/core/database.py b/app/core/database.py new file mode 100644 index 0000000..7cba7f4 --- /dev/null +++ b/app/core/database.py @@ -0,0 +1,22 @@ +from sqlalchemy import create_engine +from sqlalchemy.ext.declarative import declarative_base +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) + +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/models/__init__.py b/app/models/__init__.py new file mode 100644 index 0000000..a71e62d --- /dev/null +++ b/app/models/__init__.py @@ -0,0 +1,2 @@ +# models module initialization +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..e16407e --- /dev/null +++ b/app/models/todo.py @@ -0,0 +1,15 @@ +from sqlalchemy import Boolean, Column, DateTime, Integer, String +from sqlalchemy.sql import func + +from app.core.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, default=func.now()) + updated_at = Column(DateTime, 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..ed5c7d0 --- /dev/null +++ b/app/schemas/__init__.py @@ -0,0 +1,2 @@ +# schemas module initialization +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..cd99155 --- /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 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: datetime + + 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..106d966 --- /dev/null +++ b/main.py @@ -0,0 +1,43 @@ +from fastapi import FastAPI +from fastapi.middleware.cors import CORSMiddleware + +from app.api.v1.api import api_router +from app.core.config import settings + +app = FastAPI( + title=settings.PROJECT_NAME, + openapi_url="/openapi.json", +) + +# Set all CORS enabled origins +if settings.BACKEND_CORS_ORIGINS: + app.add_middleware( + CORSMiddleware, + allow_origins=[str(origin) for origin in settings.BACKEND_CORS_ORIGINS], + allow_credentials=True, + allow_methods=["*"], + allow_headers=["*"], + ) + +# Root endpoint +@app.get("/") +def root(): + """ + Root endpoint. + """ + return {"message": "Welcome to the Todo App API. Visit /docs for the API documentation."} + +# Health endpoint at root level +@app.get("/health") +def health_check(): + """ + Health check endpoint to verify API is running. + """ + return {"status": "ok"} + +# Include API router +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/migrations/README b/migrations/README new file mode 100644 index 0000000..3542e0e --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Generic single-database configuration with SQLite. \ No newline at end of file diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 0000000..022b41d --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,82 @@ +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +from alembic import context + +# Import the model's MetaData object +from app.core.database import Base +from app.models.todo 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. +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(): + """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: + 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..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/9c42f1a4a5a7_create_todos_table.py b/migrations/versions/9c42f1a4a5a7_create_todos_table.py new file mode 100644 index 0000000..dd66271 --- /dev/null +++ b/migrations/versions/9c42f1a4a5a7_create_todos_table.py @@ -0,0 +1,37 @@ +"""create todos table + +Revision ID: 9c42f1a4a5a7 +Revises: +Create Date: 2023-09-15 10:00:00.000000 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '9c42f1a4a5a7' +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), + sa.Column('description', sa.String(), nullable=True), + sa.Column('completed', sa.Boolean(), nullable=False, default=False), + sa.Column('created_at', sa.DateTime(), nullable=False, server_default=sa.func.now()), + sa.Column('updated_at', sa.DateTime(), nullable=False, server_default=sa.func.now(), onupdate=sa.func.now()), + 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/requirements.txt b/requirements.txt new file mode 100644 index 0000000..0b9afb5 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,7 @@ +fastapi>=0.95.0,<1.0.0 +uvicorn>=0.22.0,<1.0.0 +sqlalchemy>=2.0.0,<3.0.0 +alembic>=1.10.0,<2.0.0 +pydantic>=1.10.7,<2.0.0 +ruff>=0.0.262,<1.0.0 +python-multipart>=0.0.6,<1.0.0 \ No newline at end of file