https://github.com/markusressel/grocy-telegram-bot
A telegram bot to interact with Grocy.
https://github.com/markusressel/grocy-telegram-bot
bot cli docker grocy grocy-telegram-bot telegram telegram-bot telegram-click yaml
Last synced: 5 months ago
JSON representation
A telegram bot to interact with Grocy.
- Host: GitHub
- URL: https://github.com/markusressel/grocy-telegram-bot
- Owner: markusressel
- License: agpl-3.0
- Archived: true
- Created: 2020-02-26T20:39:19.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-07T14:15:11.000Z (almost 6 years ago)
- Last Synced: 2025-11-30T21:43:34.916Z (7 months ago)
- Topics: bot, cli, docker, grocy, grocy-telegram-bot, telegram, telegram-bot, telegram-click, yaml
- Language: Python
- Size: 227 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# grocy-telegram-bot [](https://travis-ci.com/markusressel/grocy-telegram-bot) [](https://badge.fury.io/py/grocy-telegram-bot)
**grocy-telegram-bot** is a telegram bot that allows you to receive notifications
and interact with [Grocy](https://github.com/grocy/grocy).
# Features
* Chores
* [x] Show a list of overdue chores (or all)
* [ ] Check off a chore when done
* Products
* [x] List inventory
* [x] Add/Remove a product to the inventory
* Shopping
* [x] List shopping list items
* [x] Add missing products to the shopping list
* [x] Show a list of buttons to check off shopping list items and
automatically add them to the inventory
* Recipes
* [ ] List recipes
* [ ] Add missing items for a recipe to the shopping list
* Tasks
* [ ] List tasks
* [ ] Create a new task
* [ ] Complete a task
* Batteries
* [ ] List batteries
* [ ] Update the charging state of a battery
# How it works
**grocy-telegram-bot** is a self contained python application that talks
to your [Grocy](https://github.com/grocy/grocy) instance via its REST API
for which [pygrocy](https://github.com/sebrut/pygrocy) is used.
# How to use
## Manual installation
### Install
Install **grocy-telegram-bot** using pip:
```shell
pip3 install grocy-telegram-bot
```
### Configuration
**grocy-telegram-bot** uses [container-app-conf](https://github.com/markusressel/container-app-conf)
to provide configuration via a YAML file as well as ENV variables. Have a look at the
[documentation about it](https://github.com/markusressel/container-app-conf).
See [grocy_telegram_bot_example.yaml](/grocy_telegram_bot_example.yaml) for an example in this repo.
### Run
Start the bot by using:
```shell script
grocy-telegram-bot
```
## Docker
To run **grocy-telegram-bot** using docker you can use the [markusressel/grocy-telegram-bot](https://hub.docker.com/r/markusressel/grocy-telegram-bot)
image from DockerHub:
```
sudo docker run -t \
markusressel/grocy-telegram-bot:latest
```
Configure the image using either environment variables, or mount the configuration
file from your host system to `/app/grocy_telegram_bot.yaml`.
# Contributing
GitHub is for social coding: if you want to write code, I encourage contributions through pull requests from forks
of this repository. Create GitHub tickets for bugs and new features and comment on the ones that you are interested in.
# License
```text
grocy-telegram-bot by Markus Ressel
Copyright (C) 2020 Markus Ressel
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
```