louisbilliet/trichelieu:latest

Dockerfile to create a Docker container image running an annoying discord bot.

Contributing

Pull requests on branch testing are welcome.

To add a response, add a new function in the trichelieu/cogs/spam.py file. That function will extends this bot's cog.

The bot's new responses and reactions must be unit-tested in trichelieu/cogs/test_spam.py. All un-tested new reactions won't be accepted.

A gitlab-CI pipeline is set up on this project. It will take care of :

• running unit tests
• running code-style check
• build the docker image
• run the bot for 5 seconds on a test server
• deploy the bot

In order to test the bot, you can join the test server, where the bot is set up to react every time.

Getting started

Installation

This is a standard python project, and you should use virtualenv to stay clean :

python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
pip install -r requirements_tests.txt

You should create a .env file by copying .env.tmpl and filling the environment variables accordingly.

Quickstart

Once your virtualenv is set up, run the bot locally with this command :

source .env
python src/main.py

You now have a running discord bot.

To do

• Rewrite CI pipeline (use Makefile ?)