aboutsummaryrefslogtreecommitdiff
path: root/Readme.md
blob: 315742532446e078b7646742cb05707a8611aabe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# Geldschieberbot

Geldschieberbot is a python script to bookkeep the finances of a group.
It is intended to be run on the output of signal-cli. But it should parse
other input without a lot of modification.

## Usage

Geldschieberbot is configured with a set of Environment variables:

* GSB_GROUP_ID the signal group_id you want to serve
* GSB_STORE_PATH the directory where Geldschieberbot stores the balance and the useres
* GSB_SEND_CMD the command Geldschieberbot uses to send replies

Geldschieberbot must be fed with signal messages recieved by signal-cli. 
Just pipe the output of signal-cli receive through Geldschieberbot in a cron
job and you are good to go.


Happy Geldschieben!

## License

Geldschieberbot is licensed under the [WTFPL](http://www.wtfpl.net)