🕊️ Peacebot-AI — Your Friendly Mental Health Companion

📑 Table of Contents

• 🧘‍♀️ Introduction

• 💡 Key Features

• 🧰 Tech Stack

• 🗂️ Project Structure

• 🚀 Quickstart

  • 1️⃣ Create and activate a virtual environment
  • 2️⃣ Install dependencies
  • 3️⃣ Configure your API key
  • 4️⃣ Run the App
  • 5️⃣ API Usage

• 🧩 Configuration (peacebot.ini)

• 🔄 Logging Example

• 🌱 Future Scope

• 🤝 Contributing

• 📑 Contribution Guidelines

• 🧡 Contributing is Fun!

• 👥 Contributors

• 🧪 Running the Test Suite

  • 1️⃣ Run All Tests
  • 2️⃣ Run a Specific Test File
  • 3️⃣ Expected Output

• 📄 License

• 💬 A Final Note

---

🧘‍♀️ Introduction

Peacebot-AI is an AI-powered mental health chatbot designed to provide empathetic conversations, stress management tips, and mindfulness guidance to users seeking emotional support.

It aims to create a safe, non-judgmental, and supportive environment through intelligent and compassionate AI-driven dialogue. 🌸

---

💡 Key Features

• 💬 Conversational support for stress, anxiety, and emotional wellness
• 🧠 Natural language responses powered by OpenAI’s GPT models
• 📚 Personalized mindfulness & coping strategies
• 🔒 Privacy-first — no user data storage or profiling
• 🕒 Available anytime, anywhere, for daily motivation and reflection
• ⚙️ Modular architecture for easy customization and expansion

---

🧰 Tech Stack

Component	Technology
Language	Python
Backend Framework	Flask
AI Integration	OpenAI GPT API
Frontend	HTML, CSS, JavaScript
Configuration Management	configparser, .env support
Logging	Python logging (JSON-structured logs)
Version Control	Git & GitHub

---

🗂️ Project Structure

peacebot-ai/
├── src/
│ ├── app.py # Flask entry point
│ ├── peacebot.py # Core AI response logic
│ ├── utils/
│ │ ├── config_loader.py # Handles .ini config and fallbacks
│ │ ├── logger_config.py # JSON-based structured logging
│ │ ├── retry_utils.py # Retry & exponential backoff logic
│ │ └── init.py
│ ├── static/
│ │ ├── index.html # Frontend chat interface
│ │ └── js/
│ │ └── script.js
│ └── init.py
│
├── gratitude_log.json # Logs user gratitude entries
├── peacebot.ini # Config file (API keys, retry, etc.)
├── requirements.txt # Python dependencies
├── .env # (Optional) API key storage
├── README.md # Project documentation
└── LICENSE # MIT License

---

🚀 Quickstart

1️⃣ Create and activate a virtual environment

Windows PowerShell

python -m venv .venv
.venv\Scripts\Activate.ps1

macOS/Linux

python3 -m venv .venv
source .venv/bin/activate

2️⃣ Install dependencies

pip install -r requirements.txt

3️⃣ Configure your API key

Option 1 — Using Environment Variable

setx OPENAI_API_KEY "your_openai_key_here"

Option 2 — Using .env File

Create a .env file in the project root:

OPENAI_API_KEY=your_openai_key_here

4️⃣ Run the App

python src/app.py

Visit http://127.0.0.1:5000 in your browser. You can chat with Peacebot directly in the web interface.

5️⃣ API Usage

Method	Endpoint	Description
POST	/api/chat	Send a message to Peacebot and receive a response

Example Request:

{
  "message": "I'm feeling anxious today."
}

Example Response:

{
  "response": "I hear you. It sounds like you're having a tough day. Try a short breathing exercise — inhale deeply for 4 seconds..."
}

🧩 Configuration (peacebot.ini)

Example peacebot.ini:

[openai]
api_key = your_openai_key_here
model = gpt-3.5-turbo

[retry]
max_retries = 3
base_delay = 2

[logging]
level = INFO

🔄 Logging Example

Peacebot logs structured information for traceability:

{"time": "2025-11-08 14:42:01", "level": "INFO", "module": "peacebot", "message": "Response generated successfully"}
{"time": "2025-11-08 14:42:05", "level": "WARNING", "module": "peacebot.retry", "message": "Retry 1/3 for OpenAI request"}

🌱 Future Scope

• 🧩 Integrate emotion detection using NLP
• 📈 Add mood visualization dashboard
• 🗓️ Implement daily mental wellness check-ins
• 🔐 Optional user authentication for personal sessions
• 💾 Support cloud-based session storage
• 🧠 Add local LLM fallback (offline mode)

🤝 Contributing

We welcome all contributions!
Please read the CONTRIBUTING.md file before submitting pull requests.

To suggest new ideas or report bugs:
Open an issue in the Issues tab with descriptive titles and clear acceptance criteria Example Issue Ideas

ID	Issue Title	Summary
#2	Add Config System	Introduce configparser-based modular configuration
#3	Retry & Failure Handling	Add exponential backoff for API resilience
#4	Add Emotion Classification	Use sentiment analysis to tailor responses
#5	Web Dashboard	Visualize user moods and gratitude logs

---

📑 Contribution Guidelines

• ⭐ Star the repository to show your support.
• 🍴 Fork the repo and create a new branch for your feature, fix, or idea.
• 💻 Make your changes — code, design, documentation, anything that improves the project!
• ✅ Commit your updates with a meaningful message.
• 🔁 Create a Pull Request — our team will review, suggest, and merge if all looks great.
• 🖼️ Add screenshots or demo links if applicable.

For more detailed steps, see the CONTRIBUTING.md file.

---

🧡 Contributing is Fun!

We welcome all contributions and ideas — whether it's:

• A new feature ✨
• UI/UX improvements 🎨
• Bug fixes 🐛
• or Documentation updates 📘

Your voice matters!
Feel free to open issues, start discussions, or reach out with feedback 💬

---

👥 Contributors

Thanks to these wonderful people for contributing to PeaceBot-AI 💖

---

🧪 Running the Test Suite

Peacebot now includes a robust test suite for its core backend utilities and tracing middleware.

1️⃣ Run All Tests

From your project root:

pytest -v

2️⃣ Run a Specific Test File

For example, to only test the retry utility:

pytest tests/test_retry_utils.py -v

3️⃣ ✅ Expected Output

===================== test session starts =====================
collected 9 items

tests/test_request_id_context.py ....                      [ 25%]
tests/test_logger_config.py ....                           [ 50%]
tests/test_retry_utils.py ....                             [ 75%]
tests/test_decorators.py ....                              [100%]

====================== 9 passed in 1.52s ======================

---

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

💬 A Final Note

🧘‍♀️ PeaceBot-AI — Because everyone deserves a moment of peace.
“The greatest weapon against stress is our ability to choose one thought over another.” — William James

⭐ If you find this project helpful, consider giving it a star on GitHub!