{"id":18418861,"url":"https://github.com/ki-labs/beerbot","last_synced_at":"2025-04-07T13:31:24.919Z","repository":{"id":35085919,"uuid":"179500063","full_name":"KI-labs/BeerBot","owner":"KI-labs","description":"A never-ending supply of cold beer at KI labs to maintain employee happiness","archived":false,"fork":false,"pushed_at":"2022-12-08T05:20:18.000Z","size":560,"stargazers_count":30,"open_issues_count":4,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-22T19:03:22.363Z","etag":null,"topics":["beer","bot","python","raspberry-pi-3","slack"],"latest_commit_sha":null,"homepage":"https://www.ki-labs.com/","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/KI-labs.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}},"created_at":"2019-04-04T13:11:41.000Z","updated_at":"2023-09-08T17:52:21.000Z","dependencies_parsed_at":"2023-01-15T13:45:37.215Z","dependency_job_id":null,"html_url":"https://github.com/KI-labs/BeerBot","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KI-labs%2FBeerBot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KI-labs%2FBeerBot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KI-labs%2FBeerBot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KI-labs%2FBeerBot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KI-labs","download_url":"https://codeload.github.com/KI-labs/BeerBot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247661694,"owners_count":20975101,"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":["beer","bot","python","raspberry-pi-3","slack"],"created_at":"2024-11-06T04:14:50.531Z","updated_at":"2025-04-07T13:31:24.368Z","avatar_url":"https://github.com/KI-labs.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BeerBot\n[![GitHub license](https://img.shields.io/badge/license-mit-green.svg)](https://github.com/KI-labs/BeerBot/master/LICENSE)\n\nThis repository is the central location for all things related to the beloved **BeerBot**.\n\nTread _carefully_ since this is an extremely important project within [KI labs](https://ki-labs.com/).\n\n![alt text](assets/logo.png \"BeerBot\")\n\n# Features\n\nBeerBot is a slackbot capable of the following:\n\n- checking beer (or bottled beverages) in the fridge\n- identify and analyze whether bottled beverages are *cold*\n- automatically alert when beer is running low\n\n# Processing Pipeline\n\n![alt text](assets/BeerBot.png \"Pipeline\")\n\n# Installation \n\nBeerBot can be installed by cloning this repo and its python requirements.\n\n```bash\n$ pip3 install -r requirements.txt\n```\n\n# Configuration\n\nMinimal configuration with a `.envrc` file based on `.envrc.template` is required in order to link with Slack.\n\n- build a [slackbot](https://api.slack.com/bot-users)\n\n```text\nSLACK_OAUTH_TOKEN=\nSLACK_BOT_OAUTH_TOKEN=\nCHANNEL=\nLISTEN_DELAY=1\nALERT_DELAY=10\nMIN_BEER_THRESHOLD=5\nDATA_DIR=\"/home/pi/BeerBot/data\"\nTZ=\"Europe/Berlin\"\n```\n\n# Deployment\n\nThere are three scripts for running the BeerBot engine.\n\n- `./beerbot.py`\n  - engine for checking door state and image processing\n- `./slackbot_alert.py`\n  - responsible for alerting when beer supply is critically low\n- `./slackbot_listener.py`\n  - responsible for listening to when users want beer supply or coldness information\n\nThese processes are deployed with supervisor in `./supervisor/*.conf`, see [this](http://supervisord.org/installing.html) for installation and setup.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fki-labs%2Fbeerbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fki-labs%2Fbeerbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fki-labs%2Fbeerbot/lists"}