Botochtone

Botochtone est un robot (ou bot) discord ayant pour but de filtrer les messages sur les serveurs et de supprimer le cyberharcèlement.

Lancement

Ce projet utilise uv comme gestionnaire de paquets et Python 3.11. La base de données utilisées est PostgreSQL. Pour utiliser le bot, il faut disposer d'un token d'un bot discord, voir documentation de discord.

Il existe deux méthodes pour démarrer le projet.

Native

Installez uv à partir des instructions sur leur page GitHub. Installez PostgreSQL.

Clonez le dépôt et allez dedans.

git clone https://forge.piair.dev/UQAC/Botochtone.git && cd Botochtone

Synchronisez les dépendances du projet avec uv pour les télécharger.

uv sync

Créez le fichier d'environnement à partir du fichier d'exemple et modifiez-le.

cp .env{.example,} && vim .env

Vous pouvez maintenant démarrer le bot avec la commande :

uv run -m src

Docker

Botochtone peut aussi être lancé dans un container.

À noter que votre installation de Docker peut requérir un accès administrateur à la machine, vous devez alors soit être dans le groupe docker soit rajouter sudo devant la commande. Cette note est valable pour toutes les commandes Docker.

Clonez le dépôt et allez dedans.

git clone https://forge.piair.dev/UQAC/Botochtone.git && cd Botochtone

Créez le fichier d'environnement à partir du fichier d'exemple et modifiez-le.

cp .env{.example,} && vim .env

Afin de démarrer un container utilisez la commande :

docker compose up

L'ajout de l'option -d à la fin de la commande permet de se détacher du container une fois ce-dernier lancé.

En mode détaché, le container s'arrête via la commande :

docker compose down

Si vous souhaitez relancer le bot après des modifications, il faut reconstruire le container avec l'option --build. Par exemple :

docker compose up -d --build