birthday-bot/README.md

Birthday Bot - Apprise Notifications for Configured Birthdays

Get notified for each and every birthday on multiple platforms!

Also available on Docker Hub - driftywinds/birthday-bot:latest

Commands this bot supports for each user: -

Birthday Management:

• /add_birthday - Add a new birthday
• /list_birthdays - View all birthdays
• /remove_birthday - Remove a birthday

Notification Endpoints:

• /add_endpoint - Add Apprise notification endpoint
• /list_endpoints - View all endpoints
• /remove_endpoint - Remove an endpoint

Reminders:

• /add_reminder - Add reminder schedule
• /list_reminders - View all reminders
• /remove_reminder - Remove a reminder

Settings:

• /set_timezone - Set your timezone
• /test_notifications - Test your notification setup

Birthday Format: Use MM-DD format (e.g., 03-15 for March 15) Apprise Format: Any valid Apprise URL (telegram, discord, email, etc.) (Check available endpoints and formats here)

Examples:

• Telegram: tgram://bot_token/chat_id
• Discord: discord://webhook_id/webhook_token
• Email: mailto://user:pass@smtp.gmail.com

How to use: -

1. Download the compose.yml and .env files from the repo here.
2. Customise the .env file and use your BotFather token.
3. Run docker compose up -d.

You can check logs live with this command: -

docker compose logs -f

For dev testing: -

• have python3 installed on your machine
• clone the repo
• go into the directory and run these commands: -

python3 -m venv .venv
source .venv/bin/activate
pip install --no-cache-dir -r requirements.txt

• configure .env variable.
• then run python3 bot.py