auto-ban-bot/README.md

21 lines
573 B
Markdown

# AutoBanBot
Automatically kicks and bans users, which first name or last name matches one of predefined regexes,
from a telegram group.
## You're not a spammer but you got banned?
This is definitely a bug. [File an issue on Pagure](https://pagure.io/AutoBanBot/issues). Thank you!
## Running
Before running the bot, configure the Telegram Bot API and regexes in `config.json`.
An `config.json.example` file is provided with example values.
```bash
$ virtualenv -p python3 virtual
$ source virtual/bin/activate
$ pip install -r requirements.txt
$ ./autobanbot.py
```