Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wrussell1999/form-bot
📝 Discord bot used for handling responses to forms
https://github.com/wrussell1999/form-bot
Last synced: about 1 month ago
JSON representation
📝 Discord bot used for handling responses to forms
- Host: GitHub
- URL: https://github.com/wrussell1999/form-bot
- Owner: wrussell1999
- License: mit
- Created: 2019-05-28T16:37:55.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-09-25T15:20:25.000Z (over 5 years ago)
- Last Synced: 2024-12-16T04:54:45.817Z (about 1 month ago)
- Language: Python
- Homepage:
- Size: 43 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FormBot
A discord bot for handling responses to generic online forms, through private messages.
This bot was made specially for [HackTheMidlands 4.0](https://hackthemidlands.com/), but is designed to be used for any form.
## Usage
Type `!mentor` anywhere in your server and it will trigger the bot to privately message you the questions on the form.
This bot is designed for a mentoring system, but can be altered to work for different kinds of forms quite easily.
It works with the following fields (however, everything _should_ work):
- all plaintext fields
- checkbox
- radio
### Things to note
- You can change the command from `!mentor`.
- _This can be done by renaming the method `async def mentor(ctx):`_
- You can change the final message when all the questions have been asked.
## Development
### Setup a virtual environment
```bash
$ python3 -m venv .venv
$ source .venv/bin/activate
```
### Install required packages
```bash
$ pip3 install -r requirements.txt
```
### Configuation
You will need a token for discord. Follow [this guide](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token) to get one.
Add the token, and URL for the form you want to use to `config.yaml`.
```yaml
url:
discord:
token:
start_message: "Hello there! I'm here to help"
end_message: "Someone will be over to help you shortly!"
embed_title: "Respond with one of the options below"
prefix: "!"
```
### Run
```bash
$ python3 -m formbot
```
## Contributors
- [Justin Chadwell](https://github.com/jedevc): Form scraping, validation and submission
- [Will Russell](https://github.com/wrussell1999): Discord bot used for asking questions and response handling