feat(): Dockerized toxicbot (#25)

* feat(): Dockerized toxicbot

* docs(): Added Docker build documentation

* fix(): Typo in documentation

* fixed bash script

* Updated documentation

* Update README.rst

* Update .env.example

Author: Sid200026

.dockerignore

@@ -0,0 +1,5 @@
+ToxicBot/dump/
+ToxicBot/env/
+ToxicBot/venv/
+ToxicBot/*.ini
+ToxicBot/*.log

.env.example

@@ -0,0 +1,11 @@
+PYTHON_VERSION=3.8
+POSTGRES_VERSION=13-alpine
+WORKDIR=app
+SECRET_DIR=secret
+SECRET_FILE=secret.ini
+IMAGE_NAME=sid200026/toxicbot
+IMAGE_TAG=
+POSTGRES_PASSWORD=
+POSTGRES_USER=
+POSTGRES_DB=
+POSTGRES_PORT=

.gitignore

@@ -6,4 +6,6 @@ secret.ini
 *.log
 dump/
 .vscode/
-__pycache__/
+__pycache__/
+secret/
+.env

CHANGELOG.md

@@ -4,13 +4,22 @@ All notable changes to this project will be documented in this file.
 
 ### Released
 
+- 2.0.0 : https://github.com/Sid200026/ToxicBot/releases/tag/v2.0.0
+
+  - Allows removal of users based on server limits
+  - Allows admin to set bot configurations
+  - Allows admin to generate server reports
+  - Improved toxicity detection ability
+
 - 1.0.0 : https://github.com/Sid200026/ToxicBot/releases/tag/v1.0.0
   - Discord Bot to detect and delete toxic messages
 
 ### Unreleased
 
 -0.0.2: https://github.com/Sid200026/ToxicBot/releases/tag/v1.0.0
-  - Saved files for toxic comment classification ( LATEST )
+
+- Saved files for toxic comment classification ( LATEST )
 
 -0.0.1: https://github.com/Sid200026/ToxicBot/releases/tag/v0.0.1
-  - Saved files for toxic comment classification ( OUTDATED )
+
+- Saved files for toxic comment classification ( OUTDATED )

Dockerfile

@@ -0,0 +1,10 @@
+ARG PYTHON_VERSION
+ARG WORKDIR
+FROM python:$PYTHON_VERSION
+WORKDIR /$WORKDIR
+COPY binary_download.sh .
+RUN sh binary_download.sh
+COPY ToxicBot/requirements.txt .
+RUN pip install --no-cache-dir -r requirements.txt
+COPY ToxicBot/ .
+CMD python app.py

README.rst

@@ -2,6 +2,8 @@
 ToxicBot
 ========
 
+|platform| |version| |code_style|
+
 **Discord bot for detecting and deleting toxic messages**
 
 ..
@@ -51,6 +53,15 @@ Prerequisites
 - ``pip``
 - Discord Developer Account
 
+Docker
+---------
+
+.. code-block:: bash
+
+    $ sh secret_create.sh
+    $ docker-compose build
+    $ docker-compose up -d
+
 macOS/Linux
 ---------
 
@@ -65,7 +76,7 @@ Then run ``setup.sh`` in your local ``ToxicBot`` repository:
 .. code-block:: bash
 
     $ cd ToxicBot
-    $ bash setup.sh
+    $ sh setup.sh
     
 Source the ``activate`` file and launch the ``app.py`` Python script:
 
@@ -162,3 +173,18 @@ Links
 
 - **GitHub:** https://github.com/ToxicBot-Discord/ToxicBot/
 - **Discord:** https://discord.com/
+
+.. |platform| image:: https://img.shields.io/badge/platform-discord-purple
+    :alt: Platform
+    :scale: 100%
+    :target: https://img.shields.io/badge/platform-discord-purple
+
+.. |version| image:: https://img.shields.io/badge/version-2.0.0-yellow
+    :alt: Version
+    :scale: 100%
+    :target: https://img.shields.io/badge/version-2.0.0-yellow
+
+.. |code_style| image:: https://img.shields.io/badge/code%20style-black-black
+    :alt: Code Style
+    :scale: 100%
+    :target: https://img.shields.io/badge/code%20style-black-black

ToxicBot/commands/admin.py

@@ -174,10 +174,11 @@ async def toptoxic(self, ctx, arg=None):
         member = ctx.author
         server_config = ServerConfig()
         SERVER_OWNER_ID = str(member.id)
-        SERVER_ID = 0
+        SERVER_ID = "-1"
         try:
             # Get the server config for servers that the user is an admin
-            SERVER_ID = await server_config.getConfigFromUser(SERVER_OWNER_ID)
+            record = server_config.getConfigFromUser(SERVER_OWNER_ID)
+            SERVER_ID = str(record[0])
         except AttributeError:  # Admin of multiple servers
             index, records = await self.askSpecificServer(ctx, server_config)
             if index == -1:

ToxicBot/requirements.txt

@@ -1,4 +1,4 @@
 discord.py==1.5.0
 tensorflow==2.3.1
-Keras==2.4.3
-psycopg2-binary==2.8.6
+psycopg2-binary==2.8.6
+Keras==2.4.3

binary_download.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+mkdir -p dump
+cd dump/
+wget https://github.com/ToxicBot-Discord/ToxicBot/releases/download/v0.0.2/ToxicBot_GloVeEmbedding.json
+wget https://github.com/ToxicBot-Discord/ToxicBot/releases/download/v0.0.2/ToxicBot_Tokenizer.pickle
+wget https://github.com/ToxicBot-Discord/ToxicBot/releases/download/v0.0.2/ToxicBot_Weights.h5

docker-compose.yml

@@ -0,0 +1,21 @@
+version: "3.8"
+
+services:
+  bot:
+    build:
+      context: .
+      args:
+        PYTHON_VERSION: ${PYTHON_VERSION}
+        WORKDIR: ${WORKDIR}
+    image: ${IMAGE_NAME}:${IMAGE_TAG}
+    volumes:
+      - ./${SECRET_DIR}/${SECRET_FILE}:/${SECRET_FILE}:ro
+  db:
+    image: postgres:${POSTGRES_VERSION}
+    ports:
+      - ${POSTGRES_PORT}:${POSTGRES_PORT}
+    environment:
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
+      POSTGRES_USER: ${POSTGRES_USER}
+      POSTGRES_DB: ${POSTGRES_DB}
+    restart: always