cieresults/README.md


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

# cieresults

This is an IRC bot that polls [the CIE results
page](https://myresults.cie.org.uk/cie-candidate-results/results) and announces
the prescence of results to an IRC channel.

Available under the 2-clause BSD license.

## Usage

Install dependencies (BeautifulSoup4, miniirc, requests):
```sh
python3 -m pip install -r requirements.txt
```

Add your myresults.cie.org.uk username and password to `cieauth.txt`, separated
by newlines:
```
username
passwod
```

Then, modify `cieresuts.py` and modify the `irc_config` dictionary to your
liking:
```python
irc_config = {
    "nick": "cieresults",
    "ip": "irc.runxiyu.org",
    "port": 6697,
    "channels": ["#chat"],
    "ssl": True,
    "ident": "cieresults",
    "realname": "Bot to poll CIE results",
    "quit_message": "Leaving",
}
```