{"id":30656124,"url":"https://github.com/driftywinds/birthday-bot","last_synced_at":"2025-08-31T10:07:35.281Z","repository":{"id":310872383,"uuid":"1041579827","full_name":"driftywinds/birthday-bot","owner":"driftywinds","description":"A simple Telegram bot that sends notifs for birthdays on Telegram and Apprise endpoints","archived":false,"fork":false,"pushed_at":"2025-08-21T04:43:30.000Z","size":316,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-29T02:36:39.015Z","etag":null,"topics":["apprise","birthday","bot","notification","notifications","reminder","telegram","telegrambot"],"latest_commit_sha":null,"homepage":"https://t.me/dw_bday_bot","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/driftywinds.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-20T17:40:40.000Z","updated_at":"2025-08-21T04:43:33.000Z","dependencies_parsed_at":"2025-08-20T19:38:52.908Z","dependency_job_id":"f1621e90-fe59-455d-a734-05fb6b518dda","html_url":"https://github.com/driftywinds/birthday-bot","commit_stats":null,"previous_names":["driftywinds/birthday-bot"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/driftywinds/birthday-bot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/driftywinds%2Fbirthday-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/driftywinds%2Fbirthday-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/driftywinds%2Fbirthday-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/driftywinds%2Fbirthday-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/driftywinds","download_url":"https://codeload.github.com/driftywinds/birthday-bot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/driftywinds%2Fbirthday-bot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272965918,"owners_count":25023168,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-31T02:00:09.071Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apprise","birthday","bot","notification","notifications","reminder","telegram","telegrambot"],"created_at":"2025-08-31T10:07:30.275Z","updated_at":"2025-08-31T10:07:35.271Z","avatar_url":"https://github.com/driftywinds.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Birthday Bot - Apprise Notifications for Configured Birthdays\n\n\u003cimg align=\"left\" width=\"100\" height=\"100\" src=\"https://raw.githubusercontent.com/driftywinds/birthday-bot/a4bbf916bbd13aae26a8fe6dce739f66d17a27d0/icons/birthday-gift-svgrepo-less-pad.svg\"\u003e Get notified for each and every birthday on multiple platforms!\n\n\u003cbr\u003e\n\n[![Pulls](https://img.shields.io/docker/pulls/driftywinds/birthday-bot.svg?style=for-the-badge)](https://img.shields.io/docker/pulls/driftywinds/birthday-bot.svg?style=for-the-badge)\n\nAlso available on Docker Hub - [```driftywinds/birthday-bot:latest```](https://hub.docker.com/repository/docker/driftywinds/birthday-bot/general)\n\nCommands this bot supports for each user: -\n\n**Birthday Management:**\n- `/add_birthday` - Add a new birthday\n- `/list_birthdays` - View all birthdays\n- `/remove_birthday` - Remove a birthday\n\n**Notification Endpoints:**\n- `/add_endpoint` - Add Apprise notification endpoint\n- `/list_endpoints` - View all endpoints\n- `/remove_endpoint` - Remove an endpoint\n\n**Reminders:**\n- `/add_reminder` - Add reminder schedule\n- `/list_reminders` - View all reminders\n- `/remove_reminder` - Remove a reminder\n\n**Settings:**\n- `/set_timezone` - Set your timezone\n- `/test_notifications` - Test your notification setup\n\n**Birthday Format:** Use MM-DD format (e.g., 03-15 for March 15)\n**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)\n\nExamples:\n- Telegram: `tgram://bot_token/chat_id`\n- Discord: `discord://webhook_id/webhook_token`\n- Email: `mailto://user:pass@smtp.gmail.com`\n\n### How to use: - \n\n1. Download the ```compose.yml``` and ```.env``` files from the repo [here](https://github.com/driftywinds/birthday-bot).\n2. Customise the ```.env``` file and use your BotFather token.\n3. Run ```docker compose up -d```.\n\n\u003cbr\u003e\n\nYou can check logs live with this command: - \n```\ndocker compose logs -f\n```\n### For dev testing: -\n- have python3 installed on your machine\n- clone the repo\n- go into the directory and run these commands: -\n```\npython3 -m venv .venv\nsource .venv/bin/activate\npip install --no-cache-dir -r requirements.txt\n```  \n- configure ```.env``` variable.\n- then run ```python3 bot.py```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdriftywinds%2Fbirthday-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdriftywinds%2Fbirthday-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdriftywinds%2Fbirthday-bot/lists"}