mattia/birthdaybot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
A simple telegram bot that reminds you of your friends' birthdays.
5 Commits 1 Branch 0 Tags 41 KiB
Python 100%
Go to file
Mattia Mascarello eba906075f chore: Add privacy policy for new users 
This commit adds a privacy policy feature for new users. When a new user joins, the code reads the privacy policy from the "POLICY.md" file and sends it to the user in chunks of 4096 characters, respecting Telegram's character limit. This ensures that the privacy policy is sent in a readable format without splitting it in the middle of a line.
2024-05-17 00:31:38 +02:00
dataTypes.py First Commit 2024-05-16 00:35:28 +02:00
LICENSE First Commit 2024-05-16 00:35:28 +02:00
main.py chore: Add privacy policy for new users 2024-05-17 00:31:38 +02:00
POLICY.md chore: Add privacy policy for new users 2024-05-17 00:31:38 +02:00
README.md Added TODO 2024-05-16 11:50:16 +02:00
requirements.txt First Commit 2024-05-16 00:35:28 +02:00

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
  1. Create a virtual environment 🏗️
python3 -m venv venv
  1. Activate the virtual environment 🔦
source venv/bin/activate
  1. Install the requirements 📥
pip install -r requirements.txt
  1. 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
  1. 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