Metadata-Version: 2.1
Name: grocy-telegram-bot
Version: 1.0.0
Summary: A telegram bot to interact with grocy
Home-page: https://github.com/markusressel/grocy-telegram-bot
Author: Markus Ressel
Author-email: mail@markusressel.de
License: AGPLv3+
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
Requires-Dist: babel (==2.8.0)
Requires-Dist: certifi (==2019.11.28)
Requires-Dist: cffi (==1.14.0)
Requires-Dist: chardet (==3.0.4)
Requires-Dist: container-app-conf (==5.0.0)
Requires-Dist: cryptography (==2.8)
Requires-Dist: decorator (==4.4.2)
Requires-Dist: emoji (==0.5.4)
Requires-Dist: expiringdict (==1.2.0)
Requires-Dist: future (==0.18.2)
Requires-Dist: fuzzywuzzy (==0.18.0)
Requires-Dist: idna (==2.9)
Requires-Dist: iso8601 (==0.1.12)
Requires-Dist: prometheus-client (==0.7.1)
Requires-Dist: py-range-parse (==1.0.5)
Requires-Dist: pycparser (==2.20)
Requires-Dist: pygrocy (==0.13.0)
Requires-Dist: python-dateutil (==2.8.1)
Requires-Dist: python-levenshtein (==0.12.0)
Requires-Dist: python-telegram-bot (==12.4.2)
Requires-Dist: pytimeparse (==1.1.8)
Requires-Dist: pytz (==2019.3)
Requires-Dist: requests (==2.23.0)
Requires-Dist: ruamel.yaml (==0.16.10)
Requires-Dist: ruamel.yaml.clib (==0.2.0)
Requires-Dist: six (==1.14.0)
Requires-Dist: telegram-click (==3.3.4)
Requires-Dist: toml (==0.10.0)
Requires-Dist: tornado (==6.0.4)
Requires-Dist: typing (==3.7.4.1)
Requires-Dist: tzlocal (==2.0.0)
Requires-Dist: urllib3 (==1.25.8)

# grocy-telegram-bot [![Build Status](https://travis-ci.com/markusressel/grocy-telegram-bot.svg?branch=master)](https://travis-ci.com/markusressel/grocy-telegram-bot) [![PyPI version](https://badge.fury.io/py/grocy-telegram-bot.svg)](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).

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


