Study Helper API

Lightweight FastAPI service that summarizes notes, generates flashcards, and creates quizzes using the OpenAI API.

Quick start

1. Create a virtualenv and activate it:

python3 -m venv venv
source venv/bin/activate

2. Install dependencies:

pip install -r requirements.txt

3. Copy .env.example to .env and set OPENAI_API_KEY and optionally SERVICE_API_KEY.

4. Run the app:

uvicorn main:app --reload

5. Open the docs: http://127.0.0.1:8000/docs

Deployment

Use the included render.yaml to deploy on Render. Set the environment variables in Render:

• OPENAI_API_KEY
• SERVICE_API_KEY (optional, recommended)

The start command is:

uvicorn main:app --host 0.0.0.0 --port 10000

GitHub Actions

A CI workflow is included at .github/workflows/python-app.yml. It installs dependencies and validates main.py on every push.

study-helper-api