README.md

pyRepBot - Telegram Private Group Reputation Bot

---

Table of Contents

• Requirements
• Installation
• Usage
• Bot Commands

Requirements

pyRepBot requires the following pip packages to run:

• python-dotenv any version
• pymongo/pymongo[srv] 4.0.0+
• python-telegram-bot 13.10+

Those packages can be easily installed by running the commands below in "Installation" section.

Installation

git clone https://github.com/Vombato/pyRepBot
cd /pyRepBot
pip install -r requirements.txt

Create a .env using .env-template as template setting each variable as necessary

Example:

TOKEN = YOUR_TELEGRAM_BOT_TOKEN
OWNER_ID = YOU_TELEGRAM_PERSONAL_ID
MONGODB_USER = username
MONGODB_PSW = password
MONGODB_SERVER = @yourmongodbaddress

Usage

python3 bot.py

If you want to run the bot in the background you can do:

nohup python3 bot.py &

Commands

Admin commands

Add Reputation

Send +++ as a reply to the user's message

Remove Reputation

Send --- as a reply to the user's message

Display the leaderboard

/classifica

---

Owner commands

Add Admin

/addAdmin as a reply to the user's message

**Close Monthly Leaderboard

/resetClassifica prints and tags every member in the leaderboard and then resets everything.

---

WORK IN PROGRESS

Some strings and commands are still in italian, for the moment I have no plans to translate them for internatonalization, if you wish to do so you are welcome to make a PR or fork the project!

Enjoy!