README.md

Cover bot go brr.

• Installation
  • Necessary environment variables
  • Example interaction with the script
• Dockerized version
• Non-dockerized version
  • Set the enviornment variables
  • Running the bot
• Usage
  • Commands

Installation

git clone https://github.com/Code-For-Groningen/cover-forms-bot.git
cd cover-forms-bot

Necessary environment variables

• DISCORD_BOT_TOKEN - Tutorial
• COVER_EMAIL
• COVER_PASSWORD
• COVER_CHANNEL_ID - Tutorial
• POLL_INTERVAL (optional, default: 60s)
• EMBED_IMAGE (author of embeds, default is cover logo)

Set them in the environment. Use the startup script if you'd like.

Warning

The script produces another script which only works on Unix-like systems. You have to run the bot manually or use docker on Windows. If you're using it, check out the example interaction below.

Example interaction with the script

$ cd src
$ python initial.py
Discord bot token: # This is supposed to not be visible while typing
Email (svcover.nl): [email protected]
Password: # This too
Channel ID to post in:696969696969
Polling interval (seconds):5
Embed image URL:https://raw.githubusercontent.com/CircuitReeRUG/branding/refs/heads/main/mascot/circuitree_waving.png

Dockerized version

Change the environment variables in the docker-compose.yml file.

docker compose up -d

Non-dockerized version

Set the enviornment variables

Using the script or set them manually.

Running the bot

$ pip install -r requirements.txt
>> ...
$ python3 start.py # Requires Python 3.9+

Usage

Invite the bot to your server.

Commands

Command	What do it do?
!observe	begins observing the event, pinging and showing new attendees
!stop_observe	stops observing the event