dattatreya303 / round_robin_tasker Goto Github PK

View Code? Open in Web Editor NEW

0.0 2.0 0.0 63 KB

A telegram bot for groups to assign a task to members in a round robin manner

License: MIT License

Python 100.00%

telegram-bot python

round_robin_tasker's Introduction

round_robin_tasker

A telegram bot for groups to assign a task to members in a round robin manner.

Commands supported by the bot

/add_task - Create a new task
/check_task - Check next turn for an existing task
/list_tasks - List all active tasks in this chat
/delete_task - Delete an existing task and all its data
/cancel - Terminate an ongoing command
/help - To know what each command does

The bot will consider only explicit replies to continue the conversation.

Contributing

Install dependencies

Python 3.7.2
Create a virtual environment: virtualenv venv && source venv/bin/activate
Install requirements: pip install -r requirements.txt

Generate test reports for changes

Run tests: pytest --junitxml test-results/pytests.xml --cov=. --cov-report xml
Test summary: test-results/pytests.xml
Coverage report: coverage.xml

Starting the server

Create a test bot using BotFather on Telegram.

Set secrets as environment variables by running the following script:

  #!/bin/sh
  export RRT_TOKEN="<test-bot-token>"
  export RRT_PERSISTENCE_PREFIX="<path-and-prefix-for-chat-data-store"

Start server: python bot.py

round_robin_tasker's People

Contributors

Watchers

round_robin_tasker's Issues

Add persistence to conversation handler

To make a conversationhandler persistent (save states between bot restarts) ConversationHandler(<no change>, persistent=True, name='my_name') If you want a conversationhandler to be persistent you MUST NAME IT. persistent is False by default. Adding these arguments and adding the conversationhandler to a persistence-aware updater/dispatcher will make it persistent.

Add mysql persistence for all data

Ensure backwards compatibility with current file-based chat data store

Add jenkins integration for continuous deployment

Handle commands interrupting a conversation

Problem: Updates get checked through the handlers sequentially. So if a user, while in the midst of a conversation, sends a command which is processed before the concerned conversation handler by the dispatcher, it messes up the conversation (especially if its another conversation).

Possible fixes:

Maintain a var in context.chat_data to identify any ongoing conversation. Check that var at the beginning of all command entry point callbacks. Proceed only if the var is empty.
Maintain a var in context.chat_data to identify any ongoing conversation. Add a top-level nested conversation handler. the entry point should be any message, the timeout should be infinite, states should correspond to actual user commands. Make the entry point a command handler. First, perform the check for an ongoing conversation and if found return that state. If no ongoing conversation, return the state corresponding to the command (over a switch case preferably).
Maintain a global var to identify any ongoing conversation. Send all updates to that handler only. Will require changes in the library. We will have to use a fork of the library with our changes, and not download from pip. Will need to create a separate build script.