From 15a99360c9e9feedeacfba94a4a2d4c231afb524 Mon Sep 17 00:00:00 2001 From: Timothy Jaeryang Baek Date: Thu, 18 Sep 2025 23:05:02 -0500 Subject: [PATCH] feat: flashcards --- servers/flashcard/.dockerignore | 34 +++ servers/flashcard/.webui_secret_key | 1 + servers/flashcard/Dockerfile | 51 +++++ servers/flashcard/README.md | 14 ++ servers/flashcard/compose.yaml | 7 + servers/flashcard/main.py | 315 ++++++++++++++++++++++++++++ servers/flashcard/requirements.txt | 7 + 7 files changed, 429 insertions(+) create mode 100644 servers/flashcard/.dockerignore create mode 100644 servers/flashcard/.webui_secret_key create mode 100644 servers/flashcard/Dockerfile create mode 100644 servers/flashcard/README.md create mode 100644 servers/flashcard/compose.yaml create mode 100644 servers/flashcard/main.py create mode 100644 servers/flashcard/requirements.txt diff --git a/servers/flashcard/.dockerignore b/servers/flashcard/.dockerignore new file mode 100644 index 0000000..03a268b --- /dev/null +++ b/servers/flashcard/.dockerignore @@ -0,0 +1,34 @@ +# Include any files or directories that you don't want to be copied to your +# container here (e.g., local build artifacts, temporary files, etc.). +# +# For more help, visit the .dockerignore file reference guide at +# https://docs.docker.com/go/build-context-dockerignore/ + +**/.DS_Store +**/__pycache__ +**/.venv +**/.classpath +**/.dockerignore +**/.env +**/.git +**/.gitignore +**/.project +**/.settings +**/.toolstarget +**/.vs +**/.vscode +**/*.*proj.user +**/*.dbmdl +**/*.jfm +**/bin +**/charts +**/docker-compose* +**/compose.y*ml +**/Dockerfile* +**/node_modules +**/npm-debug.log +**/obj +**/secrets.dev.yaml +**/values.dev.yaml +LICENSE +README.md diff --git a/servers/flashcard/.webui_secret_key b/servers/flashcard/.webui_secret_key new file mode 100644 index 0000000..0bcb70c --- /dev/null +++ b/servers/flashcard/.webui_secret_key @@ -0,0 +1 @@ +I9NqZuYZF2k68nCw \ No newline at end of file diff --git a/servers/flashcard/Dockerfile b/servers/flashcard/Dockerfile new file mode 100644 index 0000000..e91fca9 --- /dev/null +++ b/servers/flashcard/Dockerfile @@ -0,0 +1,51 @@ +# syntax=docker/dockerfile:1 + +# Comments are provided throughout this file to help you get started. +# If you need more help, visit the Dockerfile reference guide at +# https://docs.docker.com/go/dockerfile-reference/ + +# Want to help us make this template better? Share your feedback here: https://forms.gle/ybq9Krt8jtBL3iCk7 + +ARG PYTHON_VERSION=3.10.12 +FROM python:${PYTHON_VERSION}-slim as base + +# Prevents Python from writing pyc files. +ENV PYTHONDONTWRITEBYTECODE=1 + +# Keeps Python from buffering stdout and stderr to avoid situations where +# the application crashes without emitting any logs due to buffering. +ENV PYTHONUNBUFFERED=1 + +WORKDIR /app + +# Create a non-privileged user that the app will run under. +# See https://docs.docker.com/go/dockerfile-user-best-practices/ +ARG UID=10001 +RUN adduser \ + --disabled-password \ + --gecos "" \ + --home "/nonexistent" \ + --shell "/sbin/nologin" \ + --no-create-home \ + --uid "${UID}" \ + appuser + +# Download dependencies as a separate step to take advantage of Docker's caching. +# Leverage a cache mount to /root/.cache/pip to speed up subsequent builds. +# Leverage a bind mount to requirements.txt to avoid having to copy them into +# into this layer. +RUN --mount=type=cache,target=/root/.cache/pip \ + --mount=type=bind,source=requirements.txt,target=requirements.txt \ + python -m pip install -r requirements.txt + +# Switch to the non-privileged user to run the application. +USER appuser + +# Copy the source code into the container. +COPY . . + +# Expose the port that the application listens on. +EXPOSE 8000 + +# Run the application. +CMD uvicorn 'main:app' --host=0.0.0.0 --port=8000 diff --git a/servers/flashcard/README.md b/servers/flashcard/README.md new file mode 100644 index 0000000..a792c9d --- /dev/null +++ b/servers/flashcard/README.md @@ -0,0 +1,14 @@ +# Simple Flashcard Display API + +A simple tool for AI to display interactive flashcards. + +## 🚀 Quickstart + +```bash +git clone https://github.com/open-webui/openapi-servers +cd openapi-servers/servers/time +pip install -r requirements.txt +uvicorn main:app --host 0.0.0.0 --reload +``` + +You're live. ⏱️📡 \ No newline at end of file diff --git a/servers/flashcard/compose.yaml b/servers/flashcard/compose.yaml new file mode 100644 index 0000000..9fc4d98 --- /dev/null +++ b/servers/flashcard/compose.yaml @@ -0,0 +1,7 @@ +services: + server: + build: + context: . + ports: + - 8000:8000 + diff --git a/servers/flashcard/main.py b/servers/flashcard/main.py new file mode 100644 index 0000000..9806035 --- /dev/null +++ b/servers/flashcard/main.py @@ -0,0 +1,315 @@ +from fastapi import FastAPI, HTTPException +from fastapi.middleware.cors import CORSMiddleware +from fastapi.responses import HTMLResponse +from pydantic import BaseModel, Field +from typing import List, Optional +import json + +app = FastAPI( + title="Simple Flashcard Display API", + version="1.0.0", + description="A simple tool for AI to display interactive flashcards.", +) + +app.add_middleware( + CORSMiddleware, + allow_origins=["*"], + allow_credentials=True, + allow_methods=["*"], + allow_headers=["*"], +) + +# ------------------------------- +# Pydantic models +# ------------------------------- + + +class Flashcard(BaseModel): + front: str = Field(..., description="Front of the flashcard (question/prompt)") + back: str = Field(..., description="Back of the flashcard (answer/explanation)") + + +class FlashcardSet(BaseModel): + title: str = Field("Flashcards", description="Title for the flashcard set") + cards: List[Flashcard] = Field(..., description="List of flashcards") + description: Optional[str] = Field(None, description="Optional description") + + +# ------------------------------- +# HTML Template +# ------------------------------- + + +def flashcard_html(title: str, cards: List[dict], description: str = None) -> str: + cards_json = json.dumps(cards) + desc_html = f"

{description}

" if description else "" + + return f""" + + + + {title} + + + + +
+

{title}

+ {desc_html} + +
+
+
+ +
+ 💡 Click card to reveal answer +
+ +
+ + +
+ / +
+ + +
+
+ + + + + """ + + +# ------------------------------- +# Routes +# ------------------------------- + + +@app.post("/display", summary="Display flashcards") +def display_flashcards(flashcard_set: FlashcardSet): + """Display a set of flashcards in an interactive HTML interface.""" + if not flashcard_set.cards: + raise HTTPException(status_code=400, detail="No flashcards provided") + + cards_dict = [ + {"front": card.front, "back": card.back} for card in flashcard_set.cards + ] + + html_content = flashcard_html( + title=flashcard_set.title, + cards=cards_dict, + description=flashcard_set.description, + ) + + headers = {"Content-Disposition": "inline"} + + return HTMLResponse(content=html_content, headers=headers) + + +@app.get("/", summary="Home page") +def home(): + """Simple home page with instructions.""" + html = """ + + + + Flashcard Display Tool + + + +

🃏 Flashcard Display Tool

+

This is a simple tool for AI assistants to display interactive flashcards.

+ +

Usage

+

POST to /display with JSON data:

+ +
+ 
{
+  "title": "My Flashcards",
+  "description": "Practice questions",
+  "cards": [
+    {
+      "front": "What is 2 + 2?",
+      "back": "4"
+    },
+    {
+      "front": "Capital of France?",
+      "back": "Paris"
+    }
+  ]
+}
+
+ +

Features:

+ + + + """ + return HTMLResponse(content=html) + + +if __name__ == "__main__": + import uvicorn + + uvicorn.run(app, host="0.0.0.0", port=8000) diff --git a/servers/flashcard/requirements.txt b/servers/flashcard/requirements.txt new file mode 100644 index 0000000..b08d10d --- /dev/null +++ b/servers/flashcard/requirements.txt @@ -0,0 +1,7 @@ +fastapi +uvicorn[standard] +pydantic +python-multipart + +pytz +python-dateutil \ No newline at end of file