birthdaybot/README.md

Birthday Reminder Bot 🎂

A simple telegram bot 🤖 that reminds you of your friends' birthdays 🥳.

• Birthday list (current age ⏲️, time to birthday 🔜, sorted 🥇)
• Monthly 📆, weekly 📆, daily 📆 reminders

I made this bot for my personal use, but you can use it too. Just follow the instructions below.

Installation :

1. Clone the repository

git clone git@github.com:MatMasIt/birthdaybot.git

2. Create a virtual environment 🏗️

python3 -m venv venv

3. Activate the virtual environment 🔦

source venv/bin/activate

4. Install the requirements 📥

pip install -r requirements.txt

5. Create a .env file in the root directory and add the following variables (you can obtain the token at @botfather)

TOKEN=YOUR_TELEGRAM_BOT_TOKEN

6. Run the bot ⏯️

python bot.py

Todo 📝

• Ask for timezone 🕒 and use that to notify birthdays at the local midnight, instead of the CET time