Skip to main content

A telegram bot to interact with grocy

Project description

grocy-telegram-bot Build Status PyPI version

grocy-telegram-bot is a telegram bot that allows you to receive notifications and interact with Grocy.

How it works

grocy-telegram-bot is a self contained python application that talks to your Grocy instance via its REST API for which pygrocy is used.

How to use

Manual installation

Install

Install grocy-telegram-bot using pip:

pip3 install grocy-telegram-bot

Configuration

grocy-telegram-bot uses container-app-conf to provide configuration via a YAML file as well as ENV variables. Have a look at the documentation about it.

See grocy_telegram_bot_example.yaml for an example in this repo.

Run

Start the bot by using:

grocy-python-bot

Docker

To run grocy-telegram-bot using docker you can use the 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

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 <http://www.gnu.org/licenses/>.

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for grocy-telegram-bot, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size grocy_telegram_bot-1.0.0-py3-none-any.whl (45.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size grocy-telegram-bot-1.0.0.tar.gz (31.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page