Good Morning Bot

GoodMorningBot is a Telegram bot written in Python that sends you a personalized morning update, including:

• Weather Forecast
• Today's Calendar Events
• Daily Quote or Inspiration
• News Highlights (via RSS)

Use it to kick off your day informed and inspired with minimal setup.

---

Features

• Fetches current weather using a weather API.
• Retrieves upcoming calendar events (e.g., via Google Calendar, depending on config).
• Sends a daily quote (motivational, humorous, or curated).
• Pulls the latest news headlines via RSS feeds.
• Combines all updates into a single message and delivers it to your Telegram every morning automatically.

---

Table of Contents

1. Requirements
2. Setup & Configuration
3. Usage
4. Customization
5. Contributing
6. License

---

Requirements

Ensure you have:

• Python 3.8+
• pip or venv for package management
• A Telegram Bot Token (via @BotFather)
• API keys and/or credentials for:
  • Weather service
  • Calendar access (e.g., Google Calendar via OAuth) // not implemented yet
  • RSS feed sources (optional: if you want customized news sources)

---

Setup & Configuration

1. Clone the repository

   git clone https://github.com/Mor4eza/GoodMorningBot.git
   cd GoodMorningBot

2. Install dependencies

   pip install -r requirements.txt

3. Environment Variables

   Create a .env file or export environment variables:

   TELEGRAM_TOKEN=your_bot_token
   WEATHER_API_KEY=your_weather_api_key
   CALENDAR_CREDENTIALS_PATH=path/to/your/calendar_credentials.json
   RSS_FEED_URLS=https://example.com/rss,https://another.com/feed

4. Configuration

   • In WeatherApi.py: set up the weather API endpoint and parameters (city, units, etc.).
   • In News_RSS.py: add your preferred RSS feed URLs.
   • In DailyQuotes.py: choose or customize your quote database or source.
   • In GoodMorningBot.py: ensure environment variables are loaded and correctly used.

5. Authentication (if needed)

   • For Google Calendar: follow the [Google Calendar API Python Quickstart][gcal_quickstart] to obtain OAuth credentials and token files.

6. Run the bot manually (once) to test:

   python GoodMorningBot.py

---

Usage

• Manual Run
  Executes the script immediately to receive a morning update:

  python GoodMorningBot.py

Daily Morning Broadcast (GitHub Actions)

The polling bot (GoodMorningBot.py) must run somewhere 24/7 to receive /start and collect subscribers. The scheduled broadcast itself runs on GitHub Actions: it reads the subscriber list and sends the morning message every day at 08:00 Tehran.

Files involved:

• subscribers.py / subscribers.json — persists the chat ids of subscribed users. /start adds the user, /stop removes them.
• broadcast.py — builds the daily message and sends it to every subscriber.
• .github/workflows/morning-broadcast.yml — runs broadcast.py on a schedule.

Setup

1. Push the repository to GitHub (default branch = main).
2. Add repository secrets under Settings → Secrets and variables → Actions:
   • TELEGRAM_BOT_TOKEN
   • OPENWEATHER_API_KEY
   • TELEGRAM_CHAT_ID (optional) — a single chat/channel id for quick testing.
3. Run the bot (python GoodMorningBot.py) so users press /start; commit the updated subscribers.json afterwards so the Action can see it.
4. Trigger the workflow once manually via Actions → Morning Broadcast → Run workflow to verify, then let the schedule take over.

# .github/workflows/morning-broadcast.yml (key part)
on:
  schedule:
    - cron: "30 4 * * *"   # 08:00 Tehran (UTC+03:30) = 04:30 UTC
  workflow_dispatch:

Notes

• GitHub cron is UTC and can be delayed by a few minutes under load.
• Scheduled workflows run only on the default branch and are disabled after ~60 days without repository activity.
• Anyone can send /stop to unsubscribe.

Alternative (self-hosted cron) — if you run the bot on your own server, keep GoodMorningBot.py running and add a cron entry:

30 4 * * * cd /path/to/GoodMorningBot && /usr/bin/python3 broadcast.py >> bot.log 2>&1

---

Customization

• Weather Options: Change units (metric/imperial), location, or provider.
• Quotes: Modify the list or integrate an external API for randomness.
• RSS News: Add or remove feed URLs.
• Message Formatting: Edit templates in GoodMorningBot.py to include emojis, sections, or styles.
• Additional Features: Expand to include birthday reminders, task lists, or motivational images.

---

Contributing

Contributions are welcome! Suggestions include:

• Better error handling and logging
• Support for more APIs (e.g., news articles, inspirational images)
• Language localization for quotes or UI
• Docker Compose setup or Helm chart for Kubernetes deployment

Please open issues or PRs as needed.

---

License

Distributed under the MIT License. See LICENSE for details.

---

Sample /Today Command Message

📅 امروز یک‌شنبه، ۱۶ شهریور ۱۴۰۴

🌤 وضعیت هوا در تهران:

هوا گرم است ☀️. آب کافی بنوشید و سبک بپوشید.
 آسمان صاف و بدون ابر است 🌞.

دمای فعلی: ۳۱°
حداکثر: ۳۱° | حداقل: ۳۱°
شرایط: آسمان صاف

📰 سرخط خبرها:

- استیون اسپیلبرگ به کارگردانی فیلم Call of Duty علاقه داشت؛ اما درخواستش رد شد! زومیت | Zoomit
- مرور دوباره معمایی قدیمی؛ سیگنال واو! احتمالاً منشأ فرازمینی و قدرتی بسیار بالا داشت زومیت | Zoomit
- شیائومی ۱۶ باتری غول‌پیکری خواهد داشت زومیت | Zoomit

💡 نقل قول روز:

افسانه‌ها باید تنها به عنوان افسانه و اسطوره‌ها تنها به عنوان اسطوره آموخته شوند. آموزش موهومات به عنوان حقایق چیز وحشتناکی است. ذهن کودک آنها را می‌پذیرد و به آنها اعتقاد می‌آورد و در سالهای بعد تنها با سختی و شکنجه می‌تواند از چنگ آنها رهایی یابد. در حقیقت انسان همان طور که برای برقراری حقیقت می‌جنگد باید با خرافات نیز به مبارزه برخیزد. چرا که موهومات، نامحسوس، درک‌ناکردنی و بغرنج هستند و تکذیب آن‌ها به سختی میسر می‌شود. 
 ✍️ هیپاتیا

---

Acknowledgments

• Built using Python, Telegram Bot API, open weather map APIs, RSS feeds