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


Download files

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

Source Distribution

grocy-telegram-bot-1.0.0.tar.gz (31.5 kB view details)

Uploaded Source

Built Distribution

grocy_telegram_bot-1.0.0-py3-none-any.whl (45.6 kB view details)

Uploaded Python 3

File details

Details for the file grocy-telegram-bot-1.0.0.tar.gz.

File metadata

  • Download URL: grocy-telegram-bot-1.0.0.tar.gz
  • Upload date:
  • Size: 31.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.2

File hashes

Hashes for grocy-telegram-bot-1.0.0.tar.gz
Algorithm Hash digest
SHA256 77c0280492ad30b11d53fb2d740f6b81205f6614a6f8eae2fc1a3e35018e7019
MD5 0dbd5cee2c3c29f940c488f97e39335d
BLAKE2b-256 d319d5cafbad36da06ca6b90c73ad8a3474e9802495868ad07cffcaf97c74bd6

See more details on using hashes here.

File details

Details for the file grocy_telegram_bot-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: grocy_telegram_bot-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 45.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.2

File hashes

Hashes for grocy_telegram_bot-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 94cf61aa9c3888724512e1a2494ad6bcabd882f3b392d93c33be5fb39b3c551a
MD5 c8ee18ac75ce22c46d4d9a62689ce14d
BLAKE2b-256 ca6a64a60509a012e728384d45a83e00c8bdac26bee6cb27f9f02ca0c78a82a2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page