rama1997 / iMessage-Good-Morning-Bot

Bot that sends customizable good morning message through iMessage every morning

iMessage-Good-Morning-Bot

Bot that sends customizable morning message through iMessage every morning.

Features

• Customizable good morning greeting
• Additional content included with each message:
  • Dog Picture - Sends a new dog pic from a selection of various dog subreddits
  • Rain Alert - Sends a rain alert message if it is expected to rain
  • National Holiday Alert - Sends an alert for a popular national holiday of the current day
  • Motivation Quote - Sends a random motivation quote from a predefined list of quotes
  • NBA Schedule - Sends a message containing the daily NBA game schedule
• All messages are customizable
• Option to disable any specific message/alert

Getting Started

Requirements

• MacOS
• Apple ID

Setup

Download repo from Github onto your computer

git clone https://github.com/rama1997/iMessage-Good-Morning-Bot.git
cd iMessage-Good-Morning-Bot

Clone this repo and install packages listed in requirements.txt

pip install -r requirements.txt

You may want to install the requirements in a Python virtual environment to ensure they don't conflict with other Python projects on your system.

Configuration

• Add required API key to config.py in order to use the additional messages like the dog picture message.
• Message customization can be done in config.py, where you can edit:
  • Any of the messages provided
  • Create your own message
  • Subreddits to use as source for dog picture
  • Path to Applescript
• Create a new profile python file in the profiles folder. Example profile provided in the folder. Each profile requires:
  • Name - User will be referred to as the provided name
  • Phone number - custom messages will be sent to the provided phone number
  • City - rain alert feature will search the forecast of the provided city
  • Can disable any specific messages that you don't want to recieve, e.g., the rain alert
• Motivational quotes can be edited in quotes.txt

Usage

• Args:
  • -n --name: name of profile to use
• Run: python main.py -n name
• Use crontab to schedule program to run every morning at your desired time

Dog Picture

• Uses Reddit API to search various dog related subreddits and randomly gets a recent popular dog picture from listed subreddits.
• To use the Reddit API, requires your own reddit account and reddit API key.
• Only returns posts that contain a single picture since I found it easier and faster to view on iMessage.
• Can edit list of subreddits or add more subreddits in config.py.

Following subreddit used as sources for the dog picture:

• corgi
• dogpictures
• puppies
• shiba
• puppysmiles
• lookatmydog
• rarepuppers

Rain Alert

Uses the OpenWeather API to get daily forecast of a desired city and sends a custom rain alert message if it is expected to rain in the day.

Requires OpenWeather API Key.

National Holiday Alert

Web scrapes https://nationaltoday.com to get the most popular daily "national" holiday and sends a customizable holiday alert message. Most of the holidays are going to end up being more fun holidays, for examples, National Unicorn Day.

NBA Schedule

Sends a message containing the daily NBA game schedule retrieved using the NBA API

Todo

• Add high traffic/long commute time alert