BuggyBot

Simply a customs agent

Building :hammer_and_wrench:

:ship: Docker

1. Install docker for windows, macos or linux.
2. Run the following command docker build -t <username>/<repository>:latest -f ./docker/dockerfile .
3. Launch the image using docker run -d --restart=always --env-file .env.prod <username>/<repository>:latest

:warning: Make sure to create/modify .env.dev or .env.prod.

:warning: Default dockerfile launches Buggybot in production.

:computer: On machine

1. Download Python 3.10
2. Download MongoDB Community Server
3. Download MongoDB Compass (unless you have installed it with MongoDB Community Server)

:warning: Create two files .env.dev and .env.prod in the project root in order to interact with mongoDB. See section .env setup for more.

:warning: Do not forget to sync your requirements.txt with PyCharm.

:information_source: dev-requirements.txt contains all the extra dependencies for development purposes.

:gear: .env configuration

1. At the root of the project ./BuggyBot create two files and name them .env.dev and env.prod.
2. Add the following lines for both configuration:

   MONGODB_CONNECTION_STRING=YOUR MONGODB CONNECTION STRING
   MONGODB_CONNECTION_TIMEOUT_MS=YOUR TIMEOUT TIME IN MS
   MONGODB_DATABASE_NAME=YOUR MONGODB NAME
   STUDENT_COLLECTION_NAME=YOUR STUDENT COLLECTION NAME
   DISCORD_TOKEN=YOUR DISCORD BOT TOKEN
   SERVER_ID=YOUR SERVER ID (RIGHT CLICK ON SERVER ICON AND COPY ID)
   LOGGER_FILENAME=YOUR LOG FILENAME

:warning: Do not add space between =. Even for string, do not add ".

:information_source: One file is dedicated to dev purposes (like having a local server), and the other to production (like giving the real connection string for the database).

:information_source: If the log file is not present, it will be created automatically.

Launching :rocket:

:computer: On machine

In production:

python main.py --env prod

In development:

python main.py --env dev

:ship: Docker

:arrow_right: Create a directory to store docker-compose.yml and .env.prod (See repository for the model).

:arrow_right: Create inside your directory another that directory named log.

:heavy_plus_sign: To update the container automatically, use the updater.sh script located in ./docker/script. You may need to grant execute permissions to the script with the following command (optional):

sudo chmod +x update_buggybot.sh

:arrow_right: Create a docker-compose.yml and .env.prod (See repository for the model).

docker-compose up -d

Tools

This directory contains tools to help development. Add all python files that will help you to develop easier.

:warning: This directory should not be called from the bot directory.

:arrow_right: You can use constants from the bot directory if needed.

Commands

:warning: You must use your venv :warning:

To upload a new list of students provided by the department, run:

python tools update_students_list tools/FILENAME.xlsx

To migrate non-registered members : This command enables you to migrate members to the new bot. It will automatically register members present on the discord.

python tools migrate_students

It can happen that certain members cannot be migrated du to their name being too long or that we found duplicates. If this happens, script will ask you if you want to contact them by hand or automatically by sending them a message asking them to register.

:information_source: Note: Most of the tools commands use dev by default. To use the tool in production, simply add --env prod at the end of the command.

Commands

To fix linter and format errors run these two commands:

ruff check . --fix

black .