Release version 4.0.0

Author: regunakyle

.dockerignore

@@ -146,13 +146,14 @@ cython_debug/
 .dbeaver
 .project
 /gallery-dl
+.ruff_cache
 
 # Docker Extras
 Dockerfile
 compose.yaml
-poetry.lock
 .github
 .dockerignore
 .env.example
 /test
-.ruff_cache
+.python-version
+.gitignore

.env.example

@@ -5,7 +5,7 @@ DISCORD_TOKEN=<YOUR_TOKEN_HERE>
 PREFIX=>>
 
 # Maximum file upload size (in MiB), used by command like /pixiv
-MAX_FILE_SIZE=25
+MAX_FILE_SIZE=10
 
 # Lavalink parameters, used by the Music module
 # The Music module will be disabled if LAVALINK_URL is empty
@@ -14,7 +14,7 @@ LAVALINK_PASSWORD=youshallnotpass
 
 # AI related parameters
 # The AI module will be disabled if OPENAI_API_KEY or OPENAI_MODEL_NAME is empty
-# You can use a random string for OPENAI_API_KEY if you are using text-generation-webui
+# You can use a random string for OPENAI_API_KEY if you are using an custom OpenAI-compatible API server
 OPENAI_API_KEY=
 OPENAI_MODEL_NAME=gpt-3.5-turbo
 # If OPENAI_BASE_URL is empty, use OpenAI API endpoint instead

.python-version

@@ -0,0 +1 @@
+3.11

Dockerfile

@@ -1,31 +1,29 @@
 # syntax=docker/dockerfile:1
 
-FROM python:3.11 AS compile-image
+FROM ghcr.io/astral-sh/uv:python3.11-bookworm-slim AS compile-image
 
 WORKDIR /app
 
-COPY init.sh requirements.txt ./
+COPY . .
 
 RUN chmod u+x ./init.sh && \ 
 ./init.sh
 
 FROM python:3.11-slim AS build-image
-COPY --from=compile-image /opt/venv /opt/venv
 COPY --from=compile-image /bin/ffmpeg /bin/ffmpeg
-
-# Override system Python with the one in venv
-ENV PATH=/opt/venv/bin:$PATH \
-    XDG_CACHE_HOME=/app/volume
+COPY --from=compile-image /app /app
 
 WORKDIR /app
 
-COPY . .
+# Set XDG_CACHE_HOME for gallery-dl usage
+ENV XDG_CACHE_HOME=/app/volume
 
 RUN useradd nonroot && \ 
 printf "[safe]\ndirectory = /app" >/etc/gitconfig && \ 
 mkdir gallery-dl && \ 
+# Use `chmod 777` here instead of `chown nonroot` in case user wants to use their own docker user
 chmod -R 777 ./
 
 USER nonroot
 
-CMD ["python", "-u", "main.py"]
+CMD ["/app/.venv/bin/python", "-m", "my_discord_bot"]

README.md

@@ -12,34 +12,33 @@ This Discord bot is developed with Python 3.11. Use the same Python version to e
 
 2. Rename `.env.example` to `.env` and put your Discord token inside.
 
-3. Create a virtual python environment and install dependencies from `requirements.txt`.
+3. Create a virtual python environment, activate it, then install dependencies with `pip install -e .`.
 
-4. Run `python main.py` in your console to start up the bot.
+4. Run `python -m my_discord_bot` in your console to start up the bot.
 
 5. To use the music player, you need to run a [Lavalink](https://github.com/freyacodes/Lavalink) instance alongside the bot. Set `LAVALINK_URL` and `LAVALINK_PASSWORD` in `.env`.
 
     Example config file (`application.yml`) for Lavalink:
 
 ```yaml
-server: 
+server:
   port: 2333
   address: 0.0.0.0
 plugins:
   youtube:
     enabled: true
-    clients:
-      - MUSIC
-      - ANDROID
-      - WEB
-      - TVHTML5EMBEDDED
+    clients: ["MUSIC", "WEB", "MWEB", "WEBEMBEDDED", "ANDROID_MUSIC", "ANDROID_VR", "TV", "TVHTML5EMBEDDED"]
+    oauth:
+      enabled: true
+      refreshToken: <Redacted>
 lavalink:
   plugins:
   # See https://github.com/lavalink-devs/youtube-source for the latest version of the plugin
-    - dependency: "dev.lavalink.youtube:youtube-plugin:1.3.0"
+    - dependency: "dev.lavalink.youtube:youtube-plugin:1.11.4"
   server:
     password: "youshallnotpass"
     sources:
-      youtube: false
+      youtube: fals
 ```
 
 6. To use the AI chat command, set `OPENAI_API_KEY` and `OPENAI_MODEL_NAME` in `.env`.
@@ -53,7 +52,7 @@ Note: The `latest` tag refers to the latest stable version.
 ## Features
 
 1. A music player to play Youtube videos in any voice channel (requires a Lavalink server)
-2. Chat with AI (requires an OpenAI compatible API endpoint, e.g. [text-generation-webui](https://github.com/oobabooga/text-generation-webui))
+2. Chat with AI (requires an OpenAI compatible API server, e.g. [tabbyAPI](https://github.com/theroyallab/tabbyAPI))
 3. A bunch of other commands I created for my needs...
 
 ## TODO List
@@ -64,6 +63,7 @@ Note: The `latest` tag refers to the latest stable version.
   - [ ] AI.draw: Add [stable-diffusion-webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui) support
 - [ ] Allow passing arguments to FFMPEG (for hardware acceleration)
 - [ ] Allow bot owner to run every command (including admin only commands)
+- [ ] Setup migration with alembic
 
 ## Notable commands
 

compose.yaml

@@ -7,14 +7,14 @@ services:
       # Used by old style prefix commands; this bot only has the <PREFIX>sync prefix command
       PREFIX: ">>"
       # Maximum file upload size (in MiB), used by command like /pixiv
-      MAX_FILE_SIZE: 25
+      MAX_FILE_SIZE: 10
       # Lavalink parameters, used by the Music module
       # The Music module will be disabled if LAVALINK_URL is empty
       LAVALINK_URL: http://lavalink:2333
       LAVALINK_PASSWORD: youshallnotpass
       # AI related parameters
       # The AI module will be disabled if OPENAI_API_KEY or OPENAI_MODEL_NAME is empty
-      # You can use a random string for OPENAI_API_KEY if you are using text-generation-webui
+      # You can use a random string for OPENAI_API_KEY if you are using an custom OpenAI-compatible API server
       OPENAI_API_KEY:
       OPENAI_MODEL_NAME: gpt-3.5-turbo
       # If OPENAI_BASE_URL is empty, use OpenAI API endpoint instead

init.sh

@@ -6,10 +6,10 @@ apt -y update
 apt install -y --no-install-recommends curl xz-utils
 
 dir_name=ffmpeg
-mkdir $dir_name
-pushd $dir_name
+mkdir ../$dir_name
+pushd ../$dir_name
 
-# Download compiled binaries and perform filehash checking
+# Download compiled FFMPEG binary and perform filehash checking
 # TODO: Build a static FFMPEG instead of downloading
 xz_name=$(
     curl -JOL https://johnvansickle.com/ffmpeg/builds/ffmpeg-git-amd64-static.tar.xz \
@@ -21,19 +21,13 @@ md5_name=$(
 )
 md5sum -c "$md5_name"
 
-# Extract the archive
-mkdir $dir_name
-tar xvf "$xz_name" -C "$dir_name" --strip-components 1
-cd $dir_name
-
-# Move it to PATH
+# Extract the archive and move FFMPEG to PATH
+tar xvf "$xz_name" --strip-components 1
 mv ffmpeg /bin/ffmpeg
 
 popd
 
 # Install Python dependencies
-python -m venv /opt/venv
-PATH=/opt/venv/bin:$PATH
-pip install -r requirements.txt --no-cache-dir
+uv sync
 
 exit 0