CaseStudyGenerator / README.md
Summeya's picture
Update README.md
da6af7b verified

A newer version of the Gradio SDK is available: 6.5.0

Upgrade
metadata
title: iBoothMe Case Study Generator
emoji: πŸ“„
colorFrom: indigo
colorTo: pink
sdk: gradio
sdk_version: 5.27.0
app_file: app.py
pinned: false
license: mit

πŸ“„ iBoothMe Case Study Generator

This is a Gradio-based AI tool that generates energetic, structured marketing case studies from informal brand activation event descriptions. It supports both text input and audio input. The audio is transcribed using OpenAI Whisper, and the case study is generated using GPT-4o.


πŸš€ Features

  • πŸ“ Paste or write an informal event description
  • πŸŽ™οΈ Upload or record audio to transcribe via OpenAI Whisper
  • πŸ“‹ Generates structured case studies in the format: Challenge, Solution, and optional Results
  • ✨ Uses a pre-defined prompt system to match real-world case study tone and format
  • πŸŽ›οΈ Clean, tabbed Gradio UI with audio and text support

🧱 Tech Stack

  • Python 🐍
  • Gradio πŸŽ›οΈ
  • OpenAI GPT-4o & Whisper 🧠
  • dotenv for API key management πŸ”

🧩 File Structure

CaseStudy_Generator/
β”œβ”€β”€ main.py
β”œβ”€β”€ prompts.py 
β”œβ”€β”€ .env
β”œβ”€β”€ requirements.txt 
└── README.md 

πŸ“₯ Installation & Setup

1. Clone the Repository

git clone https://github.com/SummeyaTahir/Clean_CaseStudy_Generator.git
cd Clean_CaseStudy_Generator

2. (Optional) Create a Virtual Environment

python -m venv venv
venv\Scripts\activate         # On Windows
# source venv/bin/activate   # On Mac/Linux

3. Install the Requirements

pip install -r requirements.txt

3. Create .env File

Create a .env file in the root directory and paste this into it:


 OPENAI_API_KEY=your-openai-api-key-here

4. ▢️ Run the App

 python main.py