Skip to main content

Simple wrapper to send notifications with Telegram Bot

Project description

beves

beves is a simple wrapper to send messages with Telegram Bot. Useful to alert on something or to notify when scripts are finished!

Table of contents

  • Introduction

  • Installing

  • Getting started

  • Usage

  • References

  • License

Introduction

This module provides a simple way to send messages with Telegram Bot. Is useful to notify you when scripts are finished. You can import it into your code or using the command-line utility. In the command-line utility, beves reads the message data as a parameter or from stdin.

Installing

You can install or upgrade beves with:

$ pip install beves --upgrade

Or you can install from source with:

$ git clone https://github.com/andremmorais/beves --recursive
$ cd beves
$ python setup.py install

Getting started

To use Beves you will need the bot token and the chat_id of the sender.

The token can be generated talking with @BotFather on telegram and the chat_id can checked at https://api.telegram.org/bot<YourBOTToken>/getUpdates

Initialize beves config

$ beves
Token: xxxxx
Chat ID: xxxxx

Run from command-line with message data as argv

$ sleep 5 && beves "sleep finished";

Run from command-line with message data from stdin

$ echo "this is a test message" | beves

Run from command-line passing token and chat_id as args

$ beves -t xxxxx -i xxx "this is a test message"

Importing into your code

from beves import Beves
bot = Beves()
bot.push('test')

If you dont have the configuration you will need to pass them as arguments:

from beves import Beves
bot = Beves('token', 'chat_id')
bot.push('test')

Usage

usage: beves [-h] [-t TOKEN] [-i CHAT_ID] [-c CONFIG] [-v] [--version]
             [message [message ...]]

Simple wrapper to send notifications with Telegram Bot

positional arguments:
  message               Message to send

optional arguments:
  -h, --help            show this help message and exit
  -t TOKEN, --token TOKEN
                        telegram bot token
  -i CHAT_ID, --chat_id CHAT_ID
                        sender chat id
  -c CONFIG, --config CONFIG
                        configuration file instead of
                        /Users/andre.morais/.beves
  -v, --verbosity       increase output verbosity
  --version             show program's version number and exit

References

License

You may copy, distribute and modify the software provided that modifications are described and licensed for free under LGPL-3. Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don't have to be.

Project details


Release history Release notifications

This version

0.1

Download files

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

Files for beves, version 0.1
Filename, size File type Python version Upload date Hashes
Filename, size beves-0.1-py2.py3-none-any.whl (17.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size beves-0.1.tar.gz (5.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page