Ultimate Pollbot (@ultimate_pollbot)

Deciding where you and your friends are going for lunch today can be a real hassle... Or, for instance, deciding which games should be played at the next LAN-Party.

Since no other telegram poll-/votebot offered the full feature set my friends and I needed, I decided to write the ULTIMATE pollbot. A bot which combines all good features of all existing bots and even stuff beyond that.

Features:

The Ultimate Pollbot delivers a full set of well-tested and battle proven features. It's capable of handling hundreds of voters for a single poll, while offering a high customizability and a wide range of different poll types to choose from.

Here is a list of the most important features:

Poll types

This bot has 6 different vote modi. Each mode is useful for various scenarios. Choose wisely.

• Single vote: User get a single vote to allot
• Doodle: Users can vote with yes, no and maybe for each option.
• Block vote: Users can vote without restriction, but only one vote per option.
• Limited vote: Each user gets X votes for distribution, but only one vote per option.
• Cumulative vote: Every user gets X votes they can distribute as they like.
• Unlimited votes (Also called the shopping list): Every user can vote as often as they like, pretty much like a distributed shopping list.

Anonymity settings:

Polls can be configured to be anonymous, with the result that names of users are not visible. Polls can be made anonymous subsequently, but as soon as a poll is anonymous it stays that way forever!

Further it's possible to hide the results of the poll until it gets closed. As soon as such a poll is closed, the results will be visible. Beware!: such a poll cannot be reopened.

Poll Management:

• Addition and removal of options
• Allow other users to add new options
• Polls can be closed
• Polls can be reopened unless the poll is configured to hide the results until it has been closed.
• Polls can be completely deleted, which means that all non-forwarded occurences of the poll will be removed.
• Polls can be resetted (Delete all votes). Poll needs to be closed first
• Polls can be cloned (New poll with same options, but without votes). Poll needs to be closed first

Misc:

• Internationalization
• Polls sync between groups in realtime.
• Polls can be shared via link. This allows other users to spread the poll to arbitrary groups.
• A datepicker for easier creation of poll options
• Specify a due date, at which the poll will be automatically closed.
• Activate notifications in chats to notify users that the poll will close soon.

Sorting and Appearance:

• Results can be displayed in a detailed or summarized manner.
• The percentage bar in the vote message can be disabled.
• The bot allows to configure the sorting of the option list and and the user list for each option.
• Users can be sorted by vote date or username. Options can be sorted by highest percentage, name or by the order they've been added.

Planned features:

• A Priority poll

Acknowledgements

First of all, thanks to Lokalise for providing my projects with a free license for open-source development!

Thanks to cnpltdncsln for providing turkish translations.
Thanks to tszalbot for providing polish translations.
Thanks to FedericoAntoniazzi and LBindustries for providing italian translations.
Thanks to balboag for providing spanish translations.
Thanks to gui258 and Leonardo Frazao for providing brazilian portuguese translations.

Thanks to my patreons:

• Svenstaro
• Prior99
• Sgit Kene

Commands:

/start          Start the bot
/settings       Open the user settings menu
/create         Create a new poll
/list           List all active polls and manage them
/list_closed    List all closed polls and manage them
/notify         Activate notifications in a external chats
/help           Display the help
/donations      Get me a coffee

Installation and Starting:

This bot is developed for Linux. Windows isn't tested, but it shouldn't be too hard to make it compatible. Feel free to create a PR.

Dependencies:

• poetry to manage and install dependencies.
• Ultimate Pollbot uses postgres. Make sure the user has write/read rights.

1. Clone the repository:

    % git clone [email protected]:nukesor/ultimate-poll-bot pollbot && cd pollbot
   

2. Execute poetry install to install all dependencies.

3. Either start the pollbot once with poetry run python main.py or copy the pollbot.toml manually to ~/.config/pollbot.toml and adjust all necessary values.

4. Run poetry run python initdb.py to initialize the database.

5. Start the bot poetry run python main.py

6. If you plan to keep up to date, you need to set the current alembic revision manually. Get the latest revision with poetry run alembic history and change the current head to the newest revision with poetry run alembic stamp <revision>.

7. Now you can just execute poetry run alembic upgrade head, whenever you are updating from a previous version.

Botfather Commands

start - Start the bot
settings - Open the user settings menu
create - Create a new poll
list - List all active polls and manage them
list_closed - List all closed polls and manage them
notify - Activate notifications in external chats
help - Show the help text
donations - Get me a coffee