Upload 4 files

README.md

@@ -1,14 +1,70 @@
----
-title: CaseStudyGenerator
-emoji: 👁
-colorFrom: red
-colorTo: yellow
-sdk: gradio
-sdk_version: 5.35.0
-app_file: app.py
-pinned: false
-license: mit
-short_description: It's a case study generator
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# 📄 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
+
+```bash
+git clone https://github.com/SummeyaTahir/Clean_CaseStudy_Generator.git
+cd Clean_CaseStudy_Generator
+```
+### 2. (Optional) Create a Virtual Environment
+```bash
+python -m venv venv
+venv\Scripts\activate         # On Windows
+# source venv/bin/activate   # On Mac/Linux
+```
+
+### 3. Install the Requirements
+```bash
+pip install -r requirements.txt
+```
+
+### 3. Create .env File
+Create a .env file in the root directory and paste this into it:
+```bash
+
+ OPENAI_API_KEY=your-openai-api-key-here
+```
+### 4. ▶️ Run the App
+```bash
+ python main.py
+```
+
+

app.py

@@ -0,0 +1,61 @@
+import os
+from dotenv import load_dotenv
+import gradio as gr
+import openai
+from prompts import SYSTEM_PROMPT
+
+# 📥 Load environment variables
+load_dotenv()
+
+client = openai.OpenAI(api_key=os.getenv("OPENAI_API_KEY"))
+
+# 🔁 Transcribe audio input using OpenAI Whisper API
+def transcribe_audio(audio_file):
+    with open(audio_file, "rb") as f:
+        transcript = client.audio.transcriptions.create(
+            model="whisper-1",
+            file=f
+        )
+    return transcript.text
+
+# 💬 Call OpenAI chat with the transcribed or text input
+def call_openai(event_details):
+    prompt = SYSTEM_PROMPT.format(event_details)
+    response = client.chat.completions.create(
+        model="gpt-4o",
+        messages=[{"role": "user", "content": prompt}],
+        temperature=0.5,
+        max_tokens=1024,
+    )
+    return response.choices[0].message.content
+
+# 🔄 New function to handle audio input and route to existing pipeline
+def case_study_from_audio(audio):
+    text = transcribe_audio(audio)
+    return case_study_generator(text)
+
+# 🎛️ Original function — unchanged
+def case_study_generator(event_details):
+    gpt_response = call_openai(event_details)
+    return gpt_response
+
+# 🚀 Gradio interface with two modes: Text or Audio
+with gr.Blocks() as demo:
+    gr.Markdown("## 📄 iBoothMe Case Study Generator\nWrite a description or record audio.")
+    with gr.Tab("Text Input"):
+        text_input = gr.Textbox(
+            label="Event Description",
+            lines=10,
+            placeholder="Paste informal event description here...",
+        )
+        text_button = gr.Button("Generate from Text")
+        text_output = gr.Textbox(label="Generated Case Study", lines=15)
+        text_button.click(fn=case_study_generator, inputs=text_input, outputs=text_output)
+
+    with gr.Tab("Audio Input"):
+        audio_input = gr.Audio(type="filepath", label="Upload or Record your event description")
+        audio_button = gr.Button("Generate from Audio")
+        audio_output = gr.Textbox(label="Generated Case Study", lines=15)
+        audio_button.click(fn=case_study_from_audio, inputs=audio_input, outputs=audio_output)
+
+demo.launch()

prompts.py

@@ -0,0 +1,53 @@
+SYSTEM_PROMPT = """You are a creative writer on the iBoothMe team.
+
+Generate a short, well-structured **case study** from informal brand activation event details. Follow this format exactly:
+
+1. Start with **"Challenge:"** — explain the brand's goal/problem simply.
+2. Then write **"Solution:"** — show how iBoothMe solved it using a product or tech with flair.
+
+3. Include **"Results:"** only if the event detail mentions clear metrics or success indicators (like number of participants, engagement stats, product pickups, QR scans, impressions, conversions, etc).  
+   **If there are no measurable results or clear impact in the event detail, leave the "Results:" section out completely.**
+### Instructions for **Results** section:
+- Include no more than 3 bullet points
+- Keep bullets short, punchy, and brand-activation styled — iBoothMe tone
+- Avoid repeating similar numbers. Choose only the most impactful 2-3 results.
+**Example:**
+    - 983 unique leads collected in 6 hours  
+    - 1,200 Carmex samples distributed  
+    - 87% booth engagement rate  
+
+### Tone and Structure Related Instructions:
+- Use a confident, energetic tone — keep it short and vivid (2-3 sentences per section max).  
+- Do NOT over-explain the products. Just blend them naturally into the solution.  
+- Match the exact **style and tone** of these examples below (especially structure and length):
+
+### Examples:
+#### Case Study 1
+Challenge:
+For the IIFA 2023 Bollywood awards night, the challenge was to provide a high-end, interactive photo experience for mega film stars like Salman Khan and Hrithik Roshan, while ensuring fast, seamless operation amidst the event's glitz and glamour.
+Solution:
+We deployed our 180 Photobooth, equipped with 11 DSLR cameras to capture picture-perfect photos and GIFs. The booth allowed celebrities to strike glamorous poses, producing high-quality, shareable content. Its rapid operation ensured all stars could enjoy the experience without disrupting the flow of the event. The result was a star-studded activation that brought the essence of Bollywood to life, creating unforgettable memories for all attendees.
+
+#### Case Study 2
+Challenge:
+Shein's Challenge was letting their prospects visit their stand and remain in it to be educated about their new product line.
+Solution:
+We created a phone booth that rings unexpectedly, delivering a recorded voice message with a four-digit code, enabling participants to try unlocking the Giftbox. Inside the Giftbox lay Shein's product, and anticipation built as prospects eagerly awaited the ringing phone to try to get the prize.
+
+#### Case Study 3
+Challenge:
+Sephora's Challenge was to grab students' attention around their products in a university and collect their database while increasing their sales.
+Solution:
+The Claw captured the entire focus of Sephora's prospects on their product, attempting to seize them. The essence of this strategy lies in fostering attention and stimulating desire for their product.
+
+#### Case Study 4
+Challenge:
+Burger King introduced their new chicken burger intending to excite millennials in food courts. Their second goal was to spark curiosity among potential customers at the activation, spreading the word about their new burger throughout the town.
+Solution:
+We have developed a voice command game where the character is a Chicken, and to let the chicken jump to avoid traps, prospects had to imitate the sound of the chicken. It was exceptionally entertaining, and everyone was gathering around Burger King’s activation.
+
+Now write a case study using the following event detail:
+
+Event Detail:
+{}
+"""

requirements.txt

@@ -0,0 +1,3 @@
+gradio>=4.14.0
+openai>=1.0.0
+python-dotenv