Moddingway

Discord moderation bot for NAUR.

Environment variables

Postgres-related information is configured in the environment variables instead of a pre-created user/password. For local development, you can create a .env file to populate the following environment variables

Testing

• GUILD_ID
• DISCORD_TOKEN
• MOD_LOGGING_CHANNEL_ID
• POSTGRES_USER
• POSTGRES_PASSWORD
• POSTGRES_DB
• INACTIVE_FORUM_CHANNEL_ID
• INACTIVE_FORUM_DURATION
• PF_RECRUITMENT_CHANNEL_ID
• PF_RECRUITMENT_CHANNEL_DURATION
• NOTIFY_CHANNEL_ID
• PTC_EVENT_FORUM_ID
• PTC_EVENT_FORUM_DURATION
• EVENT_BOT_ID

Release

• DISCORD_TOKEN
• POSTGRES_HOST
• POSTGRES_PORT
• POSTGRES_DB
• POSTGRES_USER
• POSTGRES_PASSWORD
• MODDINGWAY_ENVIRONMENT

Defaults are also set for POSTGRES_PORT (5432) and POSTGRES_DB (moddingway) if those two are not set. INACTIVE_FORUM_CHANNEL_ID and INACTIVE_FORUM_DURATION are optional. The relevant task will not run if those environment variables are not defined.

To run a dockerized version of our postgres database locally, run make database-run. To run this, you will need to install and run docker desktop on your local machine. The python bot will create the tables it needs when you first run it

Development recommendations

First time setup

You will need to create a personal verion of the moddingway bot via Discord's developer portal in order to run a version of the application locally. To do this, you can follow Step 1 of Discord's Getting Started tutorial.

When you first are setting up the application, copy the file titled .env_example to be .env, and configure the missing enviornment variables. To add the bot account to your server, you can follow the discord.py instructions. The server that you use for development also will need to have a channel where the bot will output logging messages, and will need to have the following roles set up, in this priority order

• Mod
• Verified
• Exiled

In addition, you will need to give yourself the Mod role in order to properly run all moderation commands.

An optional step for development is getting a virtual environment set up for python before you start development. All required packages to run the application are defined in requirements.txt

Make Commands

We are utilizing a Makefile to simplify common commands you might use when running the application.

• make run This will stop the existing Moddingway Docker container (if running), rebuild the container, and launch the application. This is the most common command you will use for development.
• make database-run This will launch the containerized Postgres persistent database. The container uses values defined in the .env file to define the database username, password, and database name. The tables will be automatically configured when you first run the bot, or set up seed data. Data persists between container restarts.
• make database-clean This command deletes all data in the database, re-create the tables, and then set up some example data in the persistent database.
• make database-run-ephemeral This will launch the containerized Postgres temporary database for testing purposes. The container uses values defined in the .env file to define the database username, password, and database name. The tables will be automatically configured when you first run the bot, or set up seed data. Data does not persist between container restarts.
• make database-clean-ephemeral This command deletes all data in the temporary database, re-create the tables, and then set up some example data in the temporary database.
• api-reload This will start up the moddingway API. It runs with a reload flag set up, so you will not need to relaunch the command after making a code change.
• format This will run our linter over all python files. This is required for pull requests to be merged.
• clean This command removes unused docker images that you have previously built. Primarily, this is used to reclaim back disk space from docker.

Testing

This application uses pytest to run automated unit tests. To install pytest, run pip install pytest. To confirm that pytest installed properly, run the command pytest --version and you should get an output like pytest 8.3.4. If you get an error related to the command being missing, you must either add the pytest install to your path, or you can replace all instances of pytest in suggested commands with python -m pytest. Alternatively, most IDEs support running tests directly in the IDE with pytest.

Black Formatter

Files in this repo will be run through the Black Formatter. To minimize merge conflicts, it is recommended to run this formatter on your code before submitting. Most IDEs will have an extension for black, and it is recommended to use those

Running in Docker

If you want to run the app in a container, you run the application via make python-run. This command will also create a container for the postgres database, and will override the postgres host environment variable to correctly allow the two containers to interact with each other

Reseeding the Database

By default, when you run the application either via python or docker, records in the database will persist. If you want to reset the database, you can do so by running make database-clean while the postgres container is running on your machine. If the database container is not found by the command, you can first start it by running make database-run

API

To get started with moddingway API development, install the necessary packages using pip install -r requirements.txt. From there, you can start the server by running make api. You can then view the swaggerdocs page hosted on localhost:8000/docs to view all current endpoints.

Alternatively, if you want to have local changes reflected in realtime with your development API, you can run make api-reload