Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abrahammurciano/paul-bot
Hi! I'm Paul; a teeny tiny bot who's good at one thing. Making polls. And when I say good, I mean really really good. Like the bestest best bot ever at making polls. I can make open polls, I can make closed polls, I can make dynamically editable polls, and I can make them any size. And all that with a simple, good-looking, and easy to use interface! So come on and try me out in your server!
https://github.com/abrahammurciano/paul-bot
Last synced: about 9 hours ago
JSON representation
Hi! I'm Paul; a teeny tiny bot who's good at one thing. Making polls. And when I say good, I mean really really good. Like the bestest best bot ever at making polls. I can make open polls, I can make closed polls, I can make dynamically editable polls, and I can make them any size. And all that with a simple, good-looking, and easy to use interface! So come on and try me out in your server!
- Host: GitHub
- URL: https://github.com/abrahammurciano/paul-bot
- Owner: abrahammurciano
- License: gpl-3.0
- Created: 2021-10-27T16:36:56.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-03T16:54:24.000Z (9 months ago)
- Last Synced: 2024-08-03T21:03:14.173Z (3 months ago)
- Language: Python
- Size: 553 KB
- Stars: 16
- Watchers: 2
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Paul - The bestest polling bot ever
Hi! I'm Paul; a teeny tiny bot who's good at one thing. Making polls. And when I say good, I mean really really good. Like the bestest best bot ever at making polls. I can make open polls, I can make closed polls, I can make dynamically editable polls, and I can make them any size. And all that with a simple, good-looking, and easy to use interface! So come on and try me out in your server!
## Table of Contents
- [Links](#links)
- [Features](#features)
- [Usage](#usage)
- [question](#question)
- [options](#options)
- [expires](#expires)
- [allow_multiple_votes](#allow_multiple_votes)
- [allowed_vote_viewers](#allowed_vote_viewers)
- [allowed_editors](#allowed_editors)
- [allowed_voters](#allowed_voters)
- [Closing the poll](#closing-the-poll)
- [Self Hosting](#self-hosting)
## Links
### [Invite Me](https://discord.com/api/oauth2/authorize?client_id=902944827598049321&permissions=2147551296&scope=bot%20applications.commands)
### [top.gg](https://top.gg/bot/902944827598049321)
### [GitHub](https://github.com/abrahammurciano/paul-bot)
### [Discord Server](https://discord.com/invite/mzhSRnnY78)
## Features
Paul has many features. In fact I believe it has the most features out of any other poll bot I could find. After all, that's why I made him; because I couldn't find a feature rich poll bot with an easy and well designed interface.
- Uses a slash command to create the poll.
- Uses buttons to vote and interact with existing polls.
- Polls are persistent (That means if the bot goes offline it will remember its old polls when it comes back online)
- Highly customizable permissions for each action (voting, editing, viewing).
- Set expiry dates on polls.
- Option to allow multiple votes per person.
- Option to allow certain people (or everyone) to view the votes.
- Option to allow people to add options to the poll.
- Option to restrict votes to certain roles and/or users.
- Beautiful interface.
- Button for the poll creator to close the poll at will.
## Usage
This bot has a very simple interface. There is only one command. `/poll`. Below are the parameters it accepts.
### question
Specify the question that the poll is asking. This parameter is required.
> Example:
>
> `/poll question: Do you like potatoes?`
>
> 
### options
Choose which options will be available for people to vote for. This parameter is optional, and by default will be Yes/No.
When entering options, you must separate each option with a pipe character (`|`). (Trailing spaces around the pipe will be ignored.)
> Example:
>
> `/poll question: How do you like your potatoes? options: boiled | mashed | in a stew`
>
> 
### expires
With this parameter, you can choose when the poll will expire. Once the poll is expired, the vote buttons will disappear. By default, polls expire 30 days from creation.
When entering the expiry date/time, you may be quite liberal in its format. You can enter a relative date/time, such as "in 2 minutes", "1h20m", "tomorrow", "next week", etc; or you can enter an absolute date/time, such as "5 PM", "26 oct 2022", etc.
When using an absolute time such as "5 PM", it will be treated as UTC time. To specify a time zone, just include it in your input, for example "5 PM GMT+3" or "5 PM EST"
> Example:
>
> `/poll question: Do you like potatoes? expires: 1h20m`
>
> 
### allow_multiple_votes
With this parameter you can control whether or not to allow people to vote on several different options. By default each voter may vote for only one option. If you set this to True, then each voter can vote for each option up to one time.
> Example:
>
> `/poll question: Do you like potatoes? allow_multiple_votes: True`
>
> 
### allowed_vote_viewers
This parameter allows you to specify which users or roles are allowed to see who voted for each option. By default, votes are private and cannot be seen by anyone.
When specifying this parameter, you must mention all the roles and/or users you want to allow.
If this parameter is specified, then an additional button will appear underneath the poll which can be clicked by the allowed people for them to see the votes.
> Example:
>
> `/poll question: Do you like potatoes? allowed_vote_viewers: @everyone`
>
> 
### allowed_editors
With this parameter, you can specify who will be allowed to add options to the poll. By default, only you can add options.
People with permission may click the "Add Option" button, after which the bot will prompt them to enter a new option within a minute. When they do, the option will be added to the poll with a note saying who it was added by.
> Example:
>
> \*_Click "Add Option" button_
>
> 
### allowed_voters
Use this parameter to restrict who may vote to a set of users and roles. By default everyone may vote.
> Example:
>
> `/poll question: Do you like potatoes? allowed_voters: @Admin|🔱 @Abraham|👑🔱`
>
> 
### Closing the poll
You can use the big red button to close the poll manually without waiting for it to expire. Once you do this, there's no turning back. Only the poll creator can do this.
## Self Hosting
This bot is hosted on [fly.io](https://fly.io) so these instructions are tailored to that platform. However, you can host it on any other platform, you'll just need to figure out how to do it yourself.
### Create a bot
1. Go to the [Discord Developer Portal](https://discord.com/developers/applications) and create a new application.
2. Go to the "Bot" tab and click "Add Bot".
3. Copy the token and save it for later.
### Create a fly.io app
1. Install the fly.io CLI by following the instructions [here](https://fly.io/docs/getting-started/installing-flyctl/).
2. Use `flyctl auth login` or `flyctl auth signup` to (create and) log in to your fly.io account.
3. Run `flyctl create` and follow the instructions to create a new app.
### Create a PostgreSQL database
You can use any PostgreSQL hosting service you like. Here are instructions for hosting one on fly.io.
Run the following commands to create a new PostgreSQL app and attach it to your main app. When you attach it, a new user and database will be created for the main app.
```sh
flyctl postgres create --name -db
flyctl postgres attach -db
```
The output of the attach command will contain the connection string which has the username, password, host, etc. It will look something like this:
```
postgres://:@-db.flycast:5432/
```
It will be added as a secret (named `DATABASE_URL`) in the main app. Also, make a note of it as we'll need to create the initial schema on the database.
### Initialize the database
You need to run the `paul_bot/data/schema.psql` file on the database to create the necessary schema.
First run the following command to make localhost:5432 act as a proxy to the fly.io database. It will block until you cancel with `Ctrl+C`, so run it in a different shell.
```sh
flyctl proxy 5432 -a -db
```
Then run this command to import the schema:
```sh
psql postgres://:@localhost:5432/ -f paul_bot/data/schema.psql
```
### Set fly.io secrets
Use the following command to set the secrets for the bot.
```sh
flyctl secrets set BOT_TOKEN= DBG_CHANNEL= ERR_CHANNEL=
```
- `BOT_TOKEN` is the token you copied from the Discord Developer Portal.
- `DBG_CHANNEL` (optional) is the channel ID where you want to receive debug messages.
- `ERR_CHANNEL` (optional) is the channel ID where you want to receive error messages.