iranzo/stampython

# Stampython: A Telegram bot for karma accounting

[![License](https://img.shields.io/github/license/iranzo/stampython.svg)](LICENSE)
[![Build Status](https://travis-ci.org/iranzo/stampython.svg?branch=master)](https://travis-ci.org/iranzo/stampython)
[![Coverage Status](https://coveralls.io/repos/github/iranzo/stampython/badge.svg?branch=master)](https://coveralls.io/github/iranzo/stampython?branch=master)
[![Requirements Status](https://requires.io/github/iranzo/stampython/requirements.svg?branch=master)](https://requires.io/github/iranzo/stampython/requirements/?branch=master)
[![Code Climate](https://codeclimate.com/github/iranzo/stampython/badges/gpa.svg)](https://codeclimate.com/github/iranzo/stampython)
[![Pypi](http://img.shields.io/pypi/v/stampython.svg)](https://pypi.python.org/pypi/stampython/)

**Table of contents**
<!-- TOC depthFrom:2 insertAnchor:true orderedList:true -->

1. [Introduction](#introduction)
2. [Important](#important)
3. [Notes](#notes)
4. [Test](#test)
5. [Donations](#donations)

<!-- /TOC -->


<a id="markdown-introduction" name="introduction"></a>
## Introduction

Attempt to create a python script that monitors a telegram bot URL and replies to commands for adding/removing karma.

Check more information about [Telegram Bots](https://core.telegram.org/bots/).

News about the program, new features, etc at <https://t.me/redkennews>.

Quick User guide at [USERGUIDE.md](USERGUIDE.md)
Quick Admin guide at [ADMINGUIDE.md](ADMINGUIDE.md)
Configuration variables at [CONFIG.md](CONFIG.md)

Send a "/help" command to <https://telegram.me/redken_bot> to get up-to-date information about commands available

<a id="markdown-important" name="important"></a>
## Important

- The bot will need to have access to all of your messages in order to process them

<a id="markdown-notes" name="notes"></a>
## Notes

- On first execution it will create database and start filling values

<a id="markdown-test" name="test"></a>
## Test

- I've a copy running the name `@redken_bot`. Invite it to your channels if you want to give it a try or click <https://telegram.me/redken_bot>.

<a id="markdown-donations" name="donations"></a>
## Donations

The bot runs on my hardware which involves (HW, power, internet, etc), if
you wish to collaborate, please, use <https://www.paypal.me/iranzop> for
your donation.