diff --git a/README.md b/README.md index e8acfba..a373f07 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,94 @@ -# FastAPI Application +# QuickSimpleApp -This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform. +A quick and simple FastAPI application with a SQLite database. This application provides a RESTful API for managing items. + +## Features + +- FastAPI framework with automatic OpenAPI documentation +- SQLite database with SQLAlchemy ORM +- Database migrations using Alembic +- CRUD operations for items +- Health endpoint for monitoring + +## Project Structure + +``` +. +├── alembic.ini +├── app +│ ├── api +│ │ └── routes +│ │ ├── health.py +│ │ └── items.py +│ ├── core +│ │ └── config.py +│ ├── db +│ │ └── session.py +│ ├── models +│ │ ├── base.py +│ │ └── item.py +│ └── schemas +│ └── item.py +├── main.py +├── migrations +│ ├── env.py +│ ├── README +│ ├── script.py.mako +│ └── versions +│ └── a1b2c3d4e5f6_create_items_table.py +└── requirements.txt +``` + +## Setup and Installation + +1. Clone the repository +2. Create a virtual environment: + ``` + python -m venv venv + source venv/bin/activate # On Windows: venv\\Scripts\\activate + ``` +3. Install required packages: + ``` + pip install -r requirements.txt + ``` +4. Run the database migrations: + ``` + alembic upgrade head + ``` +5. Start the application: + ``` + uvicorn main:app --reload + ``` +6. The application will be available at http://localhost:8000 + +## API Documentation + +Once the application is running, you can view 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 + +### Items +- `GET /api/v1/items/` - List all items +- `POST /api/v1/items/` - Create a new item +- `GET /api/v1/items/{item_id}` - Get a specific item +- `DELETE /api/v1/items/{item_id}` - Delete an item + +## Example Request + +Creating a new item: + +```bash +curl -X POST "http://localhost:8000/api/v1/items/" \ + -H "Content-Type: application/json" \ + -d '{ + "name": "Example Item", + "description": "This is an example item", + "price": 1999, + "is_available": true + }' +``` \ No newline at end of file diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..f61a412 --- /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 + +# Absolute path version for SQLite database +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..2bcdea1 --- /dev/null +++ b/app/__init__.py @@ -0,0 +1 @@ +# This file is intentionally left empty to make the directory a Python package \ No newline at end of file diff --git a/app/api/routes/__init__.py b/app/api/routes/__init__.py new file mode 100644 index 0000000..2bcdea1 --- /dev/null +++ b/app/api/routes/__init__.py @@ -0,0 +1 @@ +# This file is intentionally left empty to make the directory a Python package \ No newline at end of file diff --git a/app/api/routes/health.py b/app/api/routes/health.py new file mode 100644 index 0000000..16bf689 --- /dev/null +++ b/app/api/routes/health.py @@ -0,0 +1,17 @@ +from fastapi import APIRouter +from pydantic import BaseModel + + +class HealthResponse(BaseModel): + status: str + + +router = APIRouter() + + +@router.get("/health", response_model=HealthResponse) +async def health_check(): + """ + Health check endpoint to verify the application is running. + """ + return HealthResponse(status="ok") \ No newline at end of file diff --git a/app/api/routes/items.py b/app/api/routes/items.py new file mode 100644 index 0000000..b6869ca --- /dev/null +++ b/app/api/routes/items.py @@ -0,0 +1,55 @@ +from typing import List +from fastapi import APIRouter, Depends, HTTPException, status +from sqlalchemy.orm import Session + +from app.db.session import get_db +from app.models.item import Item +from app.schemas.item import ItemCreate, ItemResponse + + +router = APIRouter() + + +@router.post("/items/", response_model=ItemResponse, status_code=status.HTTP_201_CREATED) +def create_item(item: ItemCreate, db: Session = Depends(get_db)): + """ + Create a new item. + """ + db_item = Item(**item.model_dump()) + db.add(db_item) + db.commit() + db.refresh(db_item) + return db_item + + +@router.get("/items/", response_model=List[ItemResponse]) +def read_items(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): + """ + Retrieve items. + """ + items = db.query(Item).offset(skip).limit(limit).all() + return items + + +@router.get("/items/{item_id}", response_model=ItemResponse) +def read_item(item_id: int, db: Session = Depends(get_db)): + """ + Retrieve a specific item by ID. + """ + db_item = db.query(Item).filter(Item.id == item_id).first() + if db_item is None: + raise HTTPException(status_code=404, detail="Item not found") + return db_item + + +@router.delete("/items/{item_id}", status_code=status.HTTP_204_NO_CONTENT, response_model=None) +def delete_item(item_id: int, db: Session = Depends(get_db)): + """ + Delete a specific item by ID. + """ + db_item = db.query(Item).filter(Item.id == item_id).first() + if db_item is None: + raise HTTPException(status_code=404, detail="Item not found") + db.delete(db_item) + 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..47a289c --- /dev/null +++ b/app/core/config.py @@ -0,0 +1,15 @@ +from pydantic_settings import BaseSettings + + +class Settings(BaseSettings): + PROJECT_NAME: str = "QuickSimpleApp" + PROJECT_DESCRIPTION: str = "A quick and simple FastAPI application" + VERSION: str = "0.1.0" + API_V1_STR: str = "/api/v1" + + 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..2bcdea1 --- /dev/null +++ b/app/db/__init__.py @@ -0,0 +1 @@ +# This file is intentionally left empty to make the directory a Python package \ No newline at end of file diff --git a/app/db/session.py b/app/db/session.py new file mode 100644 index 0000000..1bb359e --- /dev/null +++ b/app/db/session.py @@ -0,0 +1,28 @@ +from pathlib import Path +from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker + +# Create the database directory +DB_DIR = Path("/app") / "storage" / "db" +DB_DIR.mkdir(parents=True, exist_ok=True) + +# SQLAlchemy database URL +SQLALCHEMY_DATABASE_URL = f"sqlite:///{DB_DIR}/db.sqlite" + +# Create the SQLAlchemy engine +engine = create_engine( + SQLALCHEMY_DATABASE_URL, + connect_args={"check_same_thread": False} +) + +# Create a SessionLocal class +SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine) + + +# Dependency to get the database session +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..2bcdea1 --- /dev/null +++ b/app/models/__init__.py @@ -0,0 +1 @@ +# This file is intentionally left empty to make the directory a Python package \ No newline at end of file diff --git a/app/models/base.py b/app/models/base.py new file mode 100644 index 0000000..7c2377a --- /dev/null +++ b/app/models/base.py @@ -0,0 +1,3 @@ +from sqlalchemy.ext.declarative import declarative_base + +Base = declarative_base() \ No newline at end of file diff --git a/app/models/item.py b/app/models/item.py new file mode 100644 index 0000000..73725c3 --- /dev/null +++ b/app/models/item.py @@ -0,0 +1,16 @@ +from sqlalchemy import Column, Integer, String, Boolean, Text, DateTime +from sqlalchemy.sql import func + +from app.models.base import Base + + +class Item(Base): + __tablename__ = "items" + + id = Column(Integer, primary_key=True, index=True) + name = Column(String(255), nullable=False) + description = Column(Text, nullable=True) + price = Column(Integer, nullable=False) # Price in cents + is_available = Column(Boolean, default=True) + 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..2bcdea1 --- /dev/null +++ b/app/schemas/__init__.py @@ -0,0 +1 @@ +# This file is intentionally left empty to make the directory a Python package \ No newline at end of file diff --git a/app/schemas/item.py b/app/schemas/item.py new file mode 100644 index 0000000..1823596 --- /dev/null +++ b/app/schemas/item.py @@ -0,0 +1,23 @@ +from datetime import datetime +from typing import Optional +from pydantic import BaseModel, Field + + +class ItemBase(BaseModel): + name: str + description: Optional[str] = None + price: int = Field(..., description="Price in cents") + is_available: bool = True + + +class ItemCreate(ItemBase): + pass + + +class ItemResponse(ItemBase): + id: int + created_at: datetime + updated_at: Optional[datetime] = None + + class Config: + from_attributes = True \ No newline at end of file diff --git a/main.py b/main.py new file mode 100644 index 0000000..dee7ff7 --- /dev/null +++ b/main.py @@ -0,0 +1,26 @@ +import uvicorn +from fastapi import FastAPI + +from app.api.routes import health, items +from app.core.config import settings +from app.db.session import engine +from app.models.base import Base + +# Create database tables +Base.metadata.create_all(bind=engine) + +app = FastAPI( + title=settings.PROJECT_NAME, + description=settings.PROJECT_DESCRIPTION, + version=settings.VERSION, + openapi_url=f"{settings.API_V1_STR}/openapi.json", + docs_url="/docs", + redoc_url="/redoc", +) + +# Include routers +app.include_router(health.router, tags=["health"]) +app.include_router(items.router, prefix=settings.API_V1_STR, tags=["items"]) + +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..6544524 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +# Generic single-database configuration for Alembic. \ No newline at end of file diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 0000000..6f6e4b7 --- /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.models.base import Base + +# 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, + ) + + 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/a1b2c3d4e5f6_create_items_table.py b/migrations/versions/a1b2c3d4e5f6_create_items_table.py new file mode 100644 index 0000000..0373c00 --- /dev/null +++ b/migrations/versions/a1b2c3d4e5f6_create_items_table.py @@ -0,0 +1,36 @@ +"""create items table + +Revision ID: a1b2c3d4e5f6 +Revises: +Create Date: 2023-07-20 00:00:00.000000 + +""" +from alembic import op +import sqlalchemy as sa +from sqlalchemy.sql import func + + +# revision identifiers, used by Alembic. +revision = 'a1b2c3d4e5f6' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade() -> None: + op.create_table('items', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('name', sa.String(length=255), nullable=False), + sa.Column('description', sa.Text(), nullable=True), + sa.Column('price', sa.Integer(), nullable=False), + sa.Column('is_available', sa.Boolean(), nullable=True, default=True), + sa.Column('created_at', sa.DateTime(timezone=True), server_default=func.now()), + sa.Column('updated_at', sa.DateTime(timezone=True), nullable=True, onupdate=func.now()), + sa.PrimaryKeyConstraint('id') + ) + op.create_index(op.f('ix_items_id'), 'items', ['id'], unique=False) + + +def downgrade() -> None: + op.drop_index(op.f('ix_items_id'), table_name='items') + op.drop_table('items') \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..6296382 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,7 @@ +fastapi==0.109.1 +uvicorn==0.27.0 +sqlalchemy==2.0.25 +alembic==1.13.1 +pydantic==2.5.3 +ruff==0.1.9 +python-dotenv==1.0.0 \ No newline at end of file