Issue 211: Dockerize

Dockerfile

@@ -0,0 +1,15 @@
+FROM python:3.6-slim-buster
+
+RUN apt update && apt install -y git
+RUN pip install poetry
+
+# Configure Git settings for update command
+RUN git config --global user.name "Martlet"
+RUN git config --global user.email "idoneam.collective@gmail.com" 
+
+# Install requirements with pip to use Docker cache independent of project metadata
+COPY requirements.txt /mnt/
+RUN pip3 install -r /mnt/requirements.txt
+
+WORKDIR /mnt/canary
+CMD  python Main.py

Main.py

@@ -127,7 +127,9 @@ async def update(ctx):
     Update the bot by pulling changes from the git repository
     """
     bot.logger.info('Update Git repository')
-    shell_output = subprocess.check_output("git pull", shell=True)
+    shell_output = subprocess.check_output("git pull {}".format(
+        bot.config.repository),
+                                           shell=True)
     status_message = shell_output.decode("unicode_escape")
     await ctx.send('`{}`'.format(status_message))
 

README.md

@@ -53,6 +53,8 @@ You must set certain values in the `config.ini` file, in particular your Discor
     * `ModeratorRole`: The name of the role that your moderators have (for functions like DMing users).
     * `DeveloperRole`: The name of the role that your developers have (for functions like restarting the bot). This could be the same role than moderator.
     * `ReceptionChannelID`: The ID of a channel that will receive messages sent to the bot through the `answer` command (and where messages sent by mods to users with the `dm` command will be logged)
+* `[Meta]`
+    * `Repository`: The HTTPS remote for this repository, used by the `update` command as the remote when pulling.
 * `[Logging]`
     * `LogLevel`: [See this for a list of levels](https://docs.python.org/3/library/logging.html#levels). Logs from exceptions and commands like `mix` and `bac` are at the `info` level. Logging messages from the level selected *and* from more severe levels will be sent to your logging file. For example, setting the level to `info` also sends logs from `warning`, `error` and `critical`, but not  from `debug`.
     * `LogFile`: The file where the logging output will be sent (will be created there by the bot if it doesn't exist).
@@ -96,6 +98,32 @@ If you installed all dev dependencies, you can run tests with `poetry run pytest
 
 ## Running the bot
 Run `poetry run python Main.py` in your shell. Ensure that your Discord token is set in the `config.ini` file within the `config` directory.
+### Docker Container
+A Docker Container is provided for easier development. 
+#### Building the Image
+Freeze requirements to a requirements.txt 
+
+```
+$ poetry export -f requirements.txt > requirements.txt
+```
+
+From within the root of the repository:
+
+```
+$ docker build -t canary:latest .
+```
+
+#### Running the Container
+From within the root of the repository:
+
+```
+$ docker run -v $(pwd):/mnt/canary canary:latest
+```
+
+Optionally provide the `-d` flag to run the container in detached state.
+
+Note that the current host directory is mounted into the container, any changes to log files, pickles, configuration are reflected 
+across the host and the container. 
 
 ## Code Linting
 We format our code using Google's [YAPF](https://github.com/google/yapf). Our builds will reject code that do not conform to the standards defined in [`.style.yapf`](https://github.com/idoneam/Canary/blob/master/.style.yapf) . You may format your code using :

config/config.ini

@@ -30,6 +30,9 @@ ModeratorRole = Discord Moderator
 DeveloperRole = idoneam
 ReceptionChannel = martys_dm
 
+[Meta]
+Repository = https://github.com/idoneam/Canary.git
+
 [Logging]
 LogLevel = info
 LogFile = ./canary.log

config/parser.py

@@ -55,6 +55,8 @@ def __init__(self):
         self.developer_role = config['Server']['DeveloperRole']
         self.reception_channel = config['Server']['ReceptionChannel']
 
+        self.repository = config['Meta']['Repository']
+
         # Logging
         self.log_file = config['Logging']['LogFile']
         loglevel = config['Logging']['LogLevel'].lower()