Spaces:
Sleeping
Sleeping
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,70 +1,93 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
|
| 10 |
-
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
|
| 15 |
-
|
| 16 |
-
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
|
| 23 |
-
|
| 24 |
-
|
| 25 |
-
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
|
| 31 |
-
|
| 32 |
-
|
| 33 |
-
|
| 34 |
-
|
| 35 |
-
|
| 36 |
-
|
| 37 |
-
|
| 38 |
-
|
| 39 |
-
|
| 40 |
-
|
| 41 |
-
|
| 42 |
-
|
| 43 |
-
|
| 44 |
-
|
| 45 |
-
|
| 46 |
-
|
| 47 |
-
|
| 48 |
-
|
| 49 |
-
|
| 50 |
-
|
| 51 |
-
|
| 52 |
-
|
| 53 |
-
|
| 54 |
-
|
| 55 |
-
|
| 56 |
-
|
| 57 |
-
|
| 58 |
-
|
| 59 |
-
|
| 60 |
-
|
| 61 |
-
|
| 62 |
-
|
| 63 |
-
|
| 64 |
-
|
| 65 |
-
|
| 66 |
-
```bash
|
| 67 |
-
|
| 68 |
-
|
| 69 |
-
|
| 70 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
|
| 4 |
+
---
|
| 5 |
+
title: iBoothMe Case Study Generator
|
| 6 |
+
|
| 7 |
+
emoji: π
|
| 8 |
+
|
| 9 |
+
colorFrom: indigo
|
| 10 |
+
|
| 11 |
+
colorTo: pink
|
| 12 |
+
|
| 13 |
+
sdk: gradio
|
| 14 |
+
|
| 15 |
+
sdk_version: 4.27.0
|
| 16 |
+
|
| 17 |
+
app_file: app.py
|
| 18 |
+
|
| 19 |
+
pinned: false
|
| 20 |
+
|
| 21 |
+
license: mit
|
| 22 |
+
|
| 23 |
+
---
|
| 24 |
+
# π iBoothMe Case Study Generator
|
| 25 |
+
|
| 26 |
+
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**.
|
| 27 |
+
|
| 28 |
+
---
|
| 29 |
+
|
| 30 |
+
## π Features
|
| 31 |
+
|
| 32 |
+
- π Paste or write an informal event description
|
| 33 |
+
- ποΈ Upload or record audio to transcribe via OpenAI Whisper
|
| 34 |
+
- π Generates structured case studies in the format: **Challenge**, **Solution**, and optional **Results**
|
| 35 |
+
- β¨ Uses a pre-defined prompt system to match real-world case study tone and format
|
| 36 |
+
- ποΈ Clean, tabbed Gradio UI with audio and text support
|
| 37 |
+
|
| 38 |
+
---
|
| 39 |
+
|
| 40 |
+
## π§± Tech Stack
|
| 41 |
+
|
| 42 |
+
- Python π
|
| 43 |
+
- Gradio ποΈ
|
| 44 |
+
- OpenAI GPT-4o & Whisper π§
|
| 45 |
+
- dotenv for API key management π
|
| 46 |
+
|
| 47 |
+
---
|
| 48 |
+
|
| 49 |
+
## π§© File Structure
|
| 50 |
+
|
| 51 |
+
```
|
| 52 |
+
CaseStudy_Generator/
|
| 53 |
+
βββ main.py
|
| 54 |
+
βββ prompts.py
|
| 55 |
+
βββ .env
|
| 56 |
+
βββ requirements.txt
|
| 57 |
+
βββ README.md
|
| 58 |
+
```
|
| 59 |
+
|
| 60 |
+
---
|
| 61 |
+
|
| 62 |
+
## π₯ Installation & Setup
|
| 63 |
+
|
| 64 |
+
### 1. Clone the Repository
|
| 65 |
+
|
| 66 |
+
```bash
|
| 67 |
+
git clone https://github.com/SummeyaTahir/Clean_CaseStudy_Generator.git
|
| 68 |
+
cd Clean_CaseStudy_Generator
|
| 69 |
+
```
|
| 70 |
+
### 2. (Optional) Create a Virtual Environment
|
| 71 |
+
```bash
|
| 72 |
+
python -m venv venv
|
| 73 |
+
venv\Scripts\activate # On Windows
|
| 74 |
+
# source venv/bin/activate # On Mac/Linux
|
| 75 |
+
```
|
| 76 |
+
|
| 77 |
+
### 3. Install the Requirements
|
| 78 |
+
```bash
|
| 79 |
+
pip install -r requirements.txt
|
| 80 |
+
```
|
| 81 |
+
|
| 82 |
+
### 3. Create .env File
|
| 83 |
+
Create a .env file in the root directory and paste this into it:
|
| 84 |
+
```bash
|
| 85 |
+
|
| 86 |
+
OPENAI_API_KEY=your-openai-api-key-here
|
| 87 |
+
```
|
| 88 |
+
### 4. βΆοΈ Run the App
|
| 89 |
+
```bash
|
| 90 |
+
python main.py
|
| 91 |
+
```
|
| 92 |
+
|
| 93 |
+
|