https://github.com/driftywinds/birthday-bot
A simple Telegram bot that sends notifs for birthdays on Telegram and Apprise endpoints
https://github.com/driftywinds/birthday-bot
apprise birthday bot notification notifications reminder telegram telegrambot
Last synced: about 2 months ago
JSON representation
A simple Telegram bot that sends notifs for birthdays on Telegram and Apprise endpoints
- Host: GitHub
- URL: https://github.com/driftywinds/birthday-bot
- Owner: driftywinds
- License: gpl-3.0
- Created: 2025-08-20T17:40:40.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-08-21T04:43:30.000Z (about 2 months ago)
- Last Synced: 2025-08-29T02:36:39.015Z (about 2 months ago)
- Topics: apprise, birthday, bot, notification, notifications, reminder, telegram, telegrambot
- Language: Python
- Homepage: https://t.me/dw_bday_bot
- Size: 309 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Birthday Bot - Apprise Notifications for Configured Birthdays
Get notified for each and every birthday on multiple platforms!
[](https://img.shields.io/docker/pulls/driftywinds/birthday-bot.svg?style=for-the-badge)
Also available on Docker Hub - [```driftywinds/birthday-bot:latest```](https://hub.docker.com/repository/docker/driftywinds/birthday-bot/general)
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)](https://github.com/caronc/apprise?tab=readme-ov-file#supported-notifications)
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](https://github.com/driftywinds/birthday-bot).
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```