feat: Add Docker (Compose) support

kkrypt0nn · kkrypt0nn · commit e39b9fa53387 · 2025-03-05T19:42:03.000+01:00
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,8 @@
+.git/
+.github/
+database/
+venv/
+.env*
+CODE_OF_CONDUCT.md
+CONTRIBUTING.md
+UPDATES.md
diff --git a/.env.example b/.env.example
@@ -1 +1,3 @@
-TOKEN=YOUR_BOT_TOKEN_HERE
+TOKEN=YOUR_BOT_TOKEN_HERE
+PREFIX=YOUR_BOT_PREFIX_HERE
+INVITE_LINK=YOUR_BOT_INVITE_LINK_HERE
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,23 +2,23 @@
 
 Your input is amazing! Making contributing to this project as easy and transparent as possible is one of the most important side, this includes:
 
--   Reporting a bug
--   Discussing the current state of the code
--   Submitting a fix
--   Proposing new features
--   Becoming a maintainer
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Becoming a maintainer
 
 ## Wanted changes
 
--   New features
--   Better documentation
--   Fixing of spelling and grammatical issues
+- New features
+- Better documentation
+- Fixing of spelling and grammatical issues
 
 ## Unwanted changes
 
--   Whitespaces and punctuation changes
--   Word changes using synonyms
--   Entire rewrites of the project, or parts of the project - unless approved first by a maintainer
+- Whitespaces and punctuation changes
+- Word changes using synonyms
+- Entire rewrites of the project, or parts of the project - unless approved first by a maintainer
 
 ## All code changes happen through pull requests
 
@@ -34,8 +34,6 @@ Pull requests are the best way to propose changes to the codebase. We actively w
 
 This project uses [`Conventional Commits 1.0.0`](https://conventionalcommits.org/en/v1.0.0/) hence your commit messages **must** follow the same convention or your contributions will be ignored, refused or assigned to another user or maintainer.
 
-It would be more than welcome to keep your contributions as a single commit rather than, for examples, 20 `"fix: Stuff"` commits in-between. You may use multiple commmits if you believe the changes made in these commmits have nothing, or close to nothing, in common - feel free to ask a maintainer on whether or not it should be a single commit or not.
-
 ## Create a GitHub [Issue](https://github.com/kkrypt0nn/Python-Discord-Bot-Template/issues) and **then** a pull request
 
 Start contributing by first [opening a new issue](https://github.com/kkrypt0nn/Python-Discord-Bot-Template/issues/new/choose). Once that is done, you can create a pull request for the issue.
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,8 @@
+FROM python:3.12.9-slim-bookworm
+
+WORKDIR /bot
+COPY . /bot
+
+RUN python -m pip install -r requirements.txt
+
+ENTRYPOINT [ "python", "bot.py" ]
diff --git a/README.md b/README.md
@@ -73,28 +73,14 @@ Alternatively you can do the following:
 
 ## How to set up
 
-To set up the bot it was made as simple as possible.
+To set up the token you will have to make use of the [`.env.example`](.env.example) file; you should rename it to `.env` and replace the `YOUR_BOT...` content with your actual values that match for your bot.
 
-### `config.json` file
-
-There is [`config.json`](config.json) file where you can put the
-needed things to edit.
-
-Here is an explanation of what everything is:
-
-| Variable                  | What it is                                     |
-| ------------------------- | ---------------------------------------------- |
-| YOUR_BOT_PREFIX_HERE      | The prefix you want to use for normal commands |
-| YOUR_BOT_INVITE_LINK_HERE | The link to invite the bot                     |
-
-### `.env` file
-
-To set up the token you will have to make use of the [`.env.example`](.env.example) file, you should rename it to `.env` and replace `YOUR_BOT_TOKEN_HERE` with your actual bot's token.
-
-Alternatively you can simply create an environment variable named `TOKEN`.
+Alternatively you can simply create a system environment variable with the same names and their respective value.
 
 ## How to start
 
+### The _"usual"_ way
+
 To start the bot you simply need to launch, either your terminal (Linux, Mac & Windows), or your Command Prompt (
 Windows)
 .
@@ -111,7 +97,17 @@ After that you can start it with
 python bot.py
 ```
 
-> **Note** You may need to replace `python` with `py`, `python3`, `python3.11`, etc. depending on what Python versions you have installed on the machine.
+> **Note**: You may need to replace `python` with `py`, `python3`, `python3.11`, etc. depending on what Python versions you have installed on the machine.
+
+### Docker
+
+Support to start the bot in a Docker container has been added. After having [Docker](https://docker.com) installed on your machine, you can simply execute:
+
+```
+docker compose up -d --build
+```
+
+> **Note**: `-d` will make the container run in detached mode, so in the background.
 
 ## Issues or Questions
 
@@ -129,7 +125,7 @@ the [tags on this repository](https://github.com/kkrypt0nn/Python-Discord-Bot-Te
 
 ## Built With
 
-- [Python 3.11.5](https://www.python.org/)
+- [Python 3.12.9](https://www.python.org/)
 
 ## License
 
diff --git a/UPDATES.md b/UPDATES.md
@@ -2,6 +2,12 @@
 
 Here is the list of all the updates that I made on this template.
 
+### Version 6.3.0 (05 March 2025)
+
+- Added support for Docker, `docker compose up` will spin up the bot and install the requirements
+- Pinned `discord.py` version in the `requirements.txt` file
+- Removed the `config.json` file and replaced the rest with `.env` just like the token
+
 ### Version 6.2.0 (21 July 2024)
 
 - Added a new `feedback` command for showcasing the use of modals (popups)
diff --git a/bot.py b/bot.py
@@ -3,7 +3,7 @@
 Description:
 🐍 A simple template to start to code your own and personalized Discord bot in Python
 
-Version: 6.2.0
+Version: 6.3.0
 """
 
 import json
@@ -21,11 +21,7 @@
 
 from database import DatabaseManager
 
-if not os.path.isfile(f"{os.path.realpath(os.path.dirname(__file__))}/config.json"):
-    sys.exit("'config.json' not found! Please add it and try again.")
-else:
-    with open(f"{os.path.realpath(os.path.dirname(__file__))}/config.json") as file:
-        config = json.load(file)
+load_dotenv()
 
 """	
 Setup bot intents (events restrictions)
@@ -125,21 +121,22 @@ def format(self, record):
 class DiscordBot(commands.Bot):
     def __init__(self) -> None:
         super().__init__(
-            command_prefix=commands.when_mentioned_or(config["prefix"]),
+            command_prefix=commands.when_mentioned_or(os.getenv("PREFIX")),
             intents=intents,
             help_command=None,
         )
         """
         This creates custom bot variables so that we can access these variables in cogs more easily.
 
-        For example, The config is available using the following code:
-        - self.config # In this class
-        - bot.config # In this file
-        - self.bot.config # In cogs
+        For example, The logger is available using the following code:
+        - self.logger # In this class
+        - bot.logger # In this file
+        - self.bot.logger # In cogs
         """
         self.logger = logger
-        self.config = config
         self.database = None
+        self.bot_prefix = os.getenv("PREFIX")
+        self.invite_link = os.getenv("INVITE_LINK")
 
     async def init_db(self) -> None:
         async with aiosqlite.connect(
@@ -287,7 +284,5 @@ async def on_command_error(self, context: Context, error) -> None:
             raise error
 
 
-load_dotenv()
-
 bot = DiscordBot()
 bot.run(os.getenv("TOKEN"))
diff --git a/cogs/fun.py b/cogs/fun.py
@@ -3,7 +3,7 @@
 Description:
 🐍 A simple template to start to code your own and personalized Discord bot in Python
 
-Version: 6.2.0
+Version: 6.3.0
 """
 
 import random
diff --git a/cogs/general.py b/cogs/general.py
@@ -3,7 +3,7 @@
 Description:
 🐍 A simple template to start to code your own and personalized Discord bot in Python
 
-Version: 6.2.0
+Version: 6.3.0
 """
 
 import platform
@@ -87,7 +87,6 @@ async def grab_id(
         name="help", description="List all commands the bot has loaded."
     )
     async def help(self, context: Context) -> None:
-        prefix = self.bot.config["prefix"]
         embed = discord.Embed(
             title="Help", description="List of available commands:", color=0xBEBEFE
         )
@@ -99,7 +98,7 @@ async def help(self, context: Context) -> None:
             data = []
             for command in commands:
                 description = command.description.partition("\n")[0]
-                data.append(f"{prefix}{command.name} - {description}")
+                data.append(f"{command.name} - {description}")
             help_text = "\n".join(data)
             embed.add_field(
                 name=i.capitalize(), value=f"```{help_text}```", inline=False
@@ -127,7 +126,7 @@ async def botinfo(self, context: Context) -> None:
         )
         embed.add_field(
             name="Prefix:",
-            value=f"/ (Slash Commands) or {self.bot.config['prefix']} for normal commands",
+            value=f"/ (Slash Commands) or {self.bot.bot_prefix} for normal commands",
             inline=False,
         )
         embed.set_footer(text=f"Requested by {context.author}")
@@ -192,7 +191,7 @@ async def invite(self, context: Context) -> None:
         :param context: The hybrid command context.
         """
         embed = discord.Embed(
-            description=f"Invite me by clicking [here]({self.bot.config['invite_link']}).",
+            description=f"Invite me by clicking [here]({self.bot.invite_link}).",
             color=0xD75BF4,
         )
         try:
diff --git a/cogs/moderation.py b/cogs/moderation.py
@@ -3,7 +3,7 @@
 Description:
 🐍 A simple template to start to code your own and personalized Discord bot in Python
 
-Version: 6.2.0
+Version: 6.3.0
 """
 
 import os
diff --git a/cogs/owner.py b/cogs/owner.py
@@ -3,7 +3,7 @@
 Description:
 🐍 A simple template to start to code your own and personalized Discord bot in Python
 
-Version: 6.2.0
+Version: 6.3.0
 """
 
 import discord
diff --git a/cogs/template.py b/cogs/template.py
@@ -3,7 +3,7 @@
 Description:
 🐍 A simple template to start to code your own and personalized Discord bot in Python
 
-Version: 6.2.0
+Version: 6.3.0
 """
 
 from discord.ext import commands
diff --git a/config.json b/config.json
diff --git a/database/__init__.py b/database/__init__.py
@@ -3,7 +3,7 @@
 Description:
 🐍 A simple template to start to code your own and personalized Discord bot in Python
 
-Version: 6.2.0
+Version: 6.3.0
 """
 
 import aiosqlite
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,15 @@
+services:
+  discord-bot:
+    build: .
+    image: python-discord-bot-template
+    env_file:
+      - .env
+    volumes:
+      - ./database:/bot/database
+      - ./discord.log:/bot/discord.log
+
+    # Alternatively you can set the environment variables as such:
+    # /!\ The token shouldn't be written here, as this file is not ignored from Git /!\
+    # environment:
+    #   - PREFIX=YOUR_BOT_PREFIX_HERE
+    #   - INVITE_LINK=YOUR_BOT_INVITE_LINK_HERE
diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,4 @@
 aiohttp
 aiosqlite
-discord.py==2.4.0
+discord.py==2.5.2
 python-dotenv
