1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67# 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