{"id":19989204,"url":"https://github.com/clamytoe/bdaybot","last_synced_at":"2025-05-04T09:32:41.228Z","repository":{"id":84639524,"uuid":"113987829","full_name":"clamytoe/bdaybot","owner":"clamytoe","description":"Slack birthday greeting bot.","archived":false,"fork":false,"pushed_at":"2019-04-16T16:25:02.000Z","size":820,"stargazers_count":12,"open_issues_count":0,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-08T06:30:50.543Z","etag":null,"topics":["birthday","bot","python3","slack","slackbot","sqlalchemy"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/clamytoe.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}},"created_at":"2017-12-12T12:30:58.000Z","updated_at":"2024-03-01T10:46:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"e9e27ca3-e5e5-40a7-9620-3e51226a496a","html_url":"https://github.com/clamytoe/bdaybot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clamytoe%2Fbdaybot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clamytoe%2Fbdaybot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clamytoe%2Fbdaybot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clamytoe%2Fbdaybot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/clamytoe","download_url":"https://codeload.github.com/clamytoe/bdaybot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252316497,"owners_count":21728520,"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","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":["birthday","bot","python3","slack","slackbot","sqlalchemy"],"created_at":"2024-11-13T04:45:49.483Z","updated_at":"2025-05-04T09:32:41.200Z","avatar_url":"https://github.com/clamytoe.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Birthday Bot (*bdaybot*)\n\u003e Slack birthday management and greeting bot.\n\nThe concept is simple. Tell the bot your birthday and when it comes around, get a nice little birthday message.\nIn order to not wake anyone up at midnight, the messages are displayed at 09:00AM for the local time of the user.\n\n![Python version][python-version]\n[![Build Status][travis-image]][travis-url]\n[![BCH compliance][bch-image]][bch-url]\n[![GitHub issues][issues-image]][issues-url]\n[![GitHub forks][fork-image]][fork-url]\n[![GitHub Stars][stars-image]][stars-url]\n[![License][license-image]][license-url]\n\n## Design Concept\n![flowchart](img/flowchart.png)\n\n## Intial Setup\n```bash\ngit clone https://github.com/clamytoe/bdaybot.git\ncd bdaybot\n```\n\n### Python VENV Environment\n\n```bash\npython3 -m venv venv\nsource ./venv/bin/activate\npip install -r requirements.txt\n```\n\n### Anaconda Development Environment\n\n```bash\nconda env create -f environment.yml\nsource activate bdaybot\n```\n\n### Package Installation\n\n```bash\npython setup.py install\n```\n\n### How to use\nBefore you can start the bot you are going to have to set a couple of environment variables on your system:\n\n**BOT_ID** and **SLACK_BOT_TOKEN**\n\nTo start it simply use the command `bdaybot`\n\nOnce the bot is up and running and you've added it to one of your slack channels, it'll simply respond to any message directed towards it. It's not smart, any message to it should contain the **birthday** keyword.\n\nIt also accepts the **help** command and returns a short description of how it works.\n\n![help](img/bday_help.png)\n\nSample run:\n\n![sample](img/bday_sample.png)\n\nIf a date is not included in the message and you have already given it your birthday before, it will return the number of days left for it.\n\n![next_birthday](img/bday_check.png)\n\nNow it is pretty smart about filtering out different date formats, it just defaults to accepting the month before the day; sorry International users! You don't even have to supply a year for that matter!\n\n![next_tuesday](img/bday_parsing.png)\n\nIt automatically takes into account the users TimeZone and will give them a random birthday message at 09:00AM their local time. We didn't want it to wake anybody up at midnight!\n\n[python-version]:https://img.shields.io/badge/python-3.6%2B-brightgreen.svg\n[travis-image]:https://travis-ci.org/clamytoe/pguide.svg?branch=master\n[travis-url]:https://travis-ci.org/clamytoe/bdaybot\n[bch-image]:https://bettercodehub.com/edge/badge/clamytoe/bdaybot?branch=master\n[bch-url]:https://bettercodehub.com/\n[issues-image]:https://img.shields.io/github/issues/clamytoe/bdaybot.svg\n[issues-url]:https://github.com/clamytoe/bdaybot/issues\n[fork-image]:https://img.shields.io/github/forks/clamytoe/bdaybot.svg\n[fork-url]:https://github.com/clamytoe/bdaybot/network\n[stars-image]:https://img.shields.io/github/stars/clamytoe/bdaybot.svg\n[stars-url]:https://github.com/clamytoe/bdaybot/stargazers\n[license-image]:https://img.shields.io/github/license/clamytoe/bdaybot.svg\n[license-url]:https://github.com/clamytoe/bdaybot/blob/master/LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclamytoe%2Fbdaybot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclamytoe%2Fbdaybot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclamytoe%2Fbdaybot/lists"}