Summeya commited on
Commit
7438d75
Β·
verified Β·
1 Parent(s): a286c3c

Update README.md

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