Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 

Repository files navigation

StudySprint AI

StudySprint AI is a production-ready Streamlit app that turns any chapter or topic into a complete study pack using the OpenAI API.

Features

  • Streamlit frontend with a clean modern interface
  • OpenAI API integration
  • Topic input for chapters, concepts, or exam units
  • AI-generated summary, flashcards, quiz questions, and revision schedule
  • Text-file exports saved under generated_outputs/
  • Loading states and progress animation
  • User-facing error handling for missing API keys, failed requests, and invalid input
  • Configurable model through OPENAI_MODEL

Planned Later

  • PDF export
  • Dark mode
  • Voice notes
  • Upload NCERT PDFs
  • Progress tracking
  • JEE revision mode

Project Structure

StudySprint-AI/
├── app.py
├── core/
│   ├── __init__.py
│   ├── file_storage.py
│   ├── openai_client.py
│   └── prompts.py
├── .streamlit/
│   └── config.toml
├── .env.example
├── .gitignore
├── README.md
└── requirements.txt

Setup

  1. Create and activate a virtual environment.
python -m venv .venv
.venv\Scripts\activate
  1. Install dependencies.
pip install -r requirements.txt
  1. Configure your API key.
copy .env.example .env

Edit .env and set:

OPENAI_API_KEY=your_api_key_here
OPENAI_MODEL=gpt-4.1-mini

You can also enter the API key directly in the Streamlit sidebar.

Run

streamlit run app.py

The app will open in your browser. Enter a chapter or topic, choose a study goal and difficulty, then generate a study pack.

Error Handling

The app validates topic input, checks for an API key, wraps OpenAI API failures in readable messages, and handles unexpected response parsing issues.

Author:

404XKS :]

About

StudySprint AI - an app that turns any chapter or topic into a complete study pack using the OpenAI API. XD

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages