telegram-standup-bot's Introduction

Telegram Standup Bot

!!! Pls note: the bot is in experimental condition !!!

Bot address: @standup_tbe_remak_bot

Support group: https://t.me/joinchat/EiE7ykcEzD3-3DfvxzdSow

It is inspired by a geekbot which exists only for slack.

The bot has basic functionality:

Add to standup group
When a new member joins the group the bot sends an invitation to join the standup
After that upon running /report command the bot starts the standup by asking questions
After the answer to the last question the bot publishes the report to the standup channel
Each 24 h the bot sends a reminder to submit the report.
Reminders could be turned on/of via /settings command

List of commands

/help - Get a help
/start - Start a bot
/add_me - Add a user to the standup (Only for standup group)
/remove_me - Remove a user from the standup (Only for standup group)
/settings - Bot settings
/report - Submit a report
/stop_report - Stop report right now

Deployment

If you want to deploy own version of the bot then:

Create your bot at @BotFather
git clone https://github.com/ZhukovGreen/telegram-standup-bot.git
Create .env file with:
- BOT_TOKEN="your bot token"
- LOGGING_LEVEL="INFO"
docker-compose -f docker-compose.deploy.yml build
docker swarm init
docker stack deploy -c docker-compose.deploy.yml standup-bot

telegram-standup-bot's People

Contributors

Stargazers

Watchers

telegram-standup-bot's Issues

Small bug of incorrect word `yesturday?` in the question `What have you done yesturday?`

It should be What have you done yesterday?

Incorrect setting name in Dockerfile

The line Dockerfile:18 RUN poetry config settings.virtualenvs.create false results in an error during the image build.
According to the latest docs (and empirical data), this should be replaced with
RUN poetry config virtualenvs.create false

Options for Standuply schedule

We should have options for Standuply schedule so that user can make configure on starting the bot.

Step 1: Daily | Weekly | Monthy
Step 2: Specific time. Ex: 08:00 AM

/settings command has incorrect description and/or filter

When /settings command is called within a group (private/public group/supergroup), there is a misleading message This command can be used only in private groups.

I've investigated a bit, and the filter used is not filtering for private groups, but rather for private chats (types.ChatType.is_private).

Probably, the correct implementation should use types.ChatType.is_group_or_super_group with additional check for group type.
Or, it may use aiogram.dispatcher.filters.builtin.AdminFilter (available in recent [email protected], current settings file is locked to 2.0 and 2.0.1).

Recommend Projects