furkan / korsan-jaime-bot

Telegram Bot for debt tracking in the house

korsan-jaime-bot

This telegram bot's purpose is to keep track of payments and debts among 3 housemates.

Usage

Follow the procedures to install the bot, then type /help.

Requirements

pip3 install -r requirements.txt

Additional Files

There must be two additional files in the same folder with kjbot.py:

balance.txt and config.py

Structure of balance.txt

Just one line will suffice:

0,0,0,

The bot will change the numbers to what they must be as payments take place.

Structure of config.py

chat_id = 123456789

user1_id = "123456789"
user2_id = "123456788"
user3_id = "123456787"

user1_name = "furkan"
user2_name = "albert"
user3_name = "nikola"

# '/paid 100 fa' works the same as '/paid 100 furkan'
user1_nicknames = ['furkan', 'aldemir', 'fa', 'f']
user2_nicknames = ['albert', 'einstein', 'ae', 'e']
user3_nicknames = ['nikola', 'tesla', 'nt', 'n', 't']

token = "OBTAINED_FROM_BOTFATHER"

SECRET = 'TOTALLY_MADE_UP_FOR_FLASK_WEBHOOKS'

URL = 'WHEREVER_THE_BOT_IS_HOSTED'

Obtaining user_id

userinfobot

Obtaining chat_id of the group

Add this bot to your group: Chat ID Echo

Obtaining token

BotFather

Running the bot

From the console: python3 main.py

As a docker compose service: docker compose up -d

korsan-jaime-bot's Issues

Docker

Dockerize the project

directory name

korsan-jaime-bot/kjbot.py

Line 36 in a9f0702

with open('/home/kjbot/korsan-jaime-bot/balance.txt') as file:

the directory should not be hard coded

Database management

Instead of using a single txt file, this project could use a real database. It's not a must, though, so no rush.

Migrate to FastAPI

Flask was perfect for this project, but let's do the rewrite with FastAPI.

CI/CD

Create GitHub Actions/workflows for automatic lint/type checking and code testing.

Instructions

There should be better instructions for both developers and users.

Bare exceptions

Figure out the specific exception types and stop using bare exceptions where applicable.

individual messages

korsan-jaime-bot/kjbot.py

Line 194 in a9f0702

bot.send_message(config.user1_id, m.text[7:], parse_mode='Markdown')

does not work before everyone starts the bot individually