Merge pull request #13 from jarulsamy/dev

v1.0.2

Dockerfile

@@ -1,11 +1,13 @@
-# Python 3.7
-FROM python:3.7
+FROM python:3.7-slim
+
+LABEL maintainer="Joshua Arulsamy <joshua.gf.arul@gmail.com>"
 
-# Update system
-RUN apt-get -y update
-RUN apt-get -y upgrade
 # Install ffmpeg
-RUN apt-get install -y ffmpeg
+RUN apt-get -y update && \
+    apt-get install -y --no-install-recommends ffmpeg=7:4.1.6-1~deb10u1 && \
+    apt-get autoremove -y && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/*
 
 # All source code
 WORKDIR /src
@@ -14,11 +16,10 @@ WORKDIR /src
 COPY requirements.txt .
 
 # Install all dependencies.
-RUN pip install -r requirements.txt
+RUN pip install --no-cache-dir -r requirements.txt
 
 # Copy PlexBot over to src.
 COPY PlexBot/ PlexBot
 
 # Run the bot
-# CMD ["python", "-OO", "-m", "PlexBot"]
-CMD ["python", "-m", "PlexBot"]
+CMD ["python", "-OO", "-m", "PlexBot"]

Jenkinsfile

@@ -25,6 +25,7 @@ pipeline {
                 sh  ''' conda create --yes -n ${BUILD_TAG} python
                         source /var/lib/jenkins/miniconda3/etc/profile.d/conda.sh
                         conda activate ${BUILD_TAG}
+                        pip install -r requirements.txt
                         pip install pylint
                     '''
             }
@@ -35,7 +36,7 @@ pipeline {
                 echo "Style check"
                 sh  ''' source /var/lib/jenkins/miniconda3/etc/profile.d/conda.sh
                         conda activate ${BUILD_TAG}
-                        pylint CHANGE_ME || true
+                        pylint PlexBot || true
                     '''
             }
         }
@@ -47,20 +48,12 @@ pipeline {
                 }
             }
             steps {
-                sh  ''' source /var/lib/jenkins/miniconda3/etc/profile.d/conda.sh
-                        conda activate ${BUILD_TAG}
-                        pwd
-                        ls
-                        python setup.py bdist_wheel
-                    '''
+                sh  './deploy/build.sh'
             }
-            post {
-                always {
-                    // Archive unit tests for the future
-                    archiveArtifacts (allowEmptyArchive: true,
-                                     artifacts: 'dist/*whl',
-                                     fingerprint: true)
-                }
+        }
+        stage('Push Image') {
+            steps {
+                sh './deploy/push.sh'
             }
         }
     }
@@ -68,14 +61,7 @@ pipeline {
     post {
         always {
             sh 'conda remove --yes -n ${BUILD_TAG} --all'
-        }
-        failure {
-            emailext (
-                subject: "FAILED: Job '${env.JOB_NAME} [${env.BUILD_NUMBER}]'",
-                body: """<p>FAILED: Job '${env.JOB_NAME} [${env.BUILD_NUMBER}]':</p>
-                         <p>Check console output at &QUOT;<a href='${env.BUILD_URL}'>${env.JOB_NAME} [${env.BUILD_NUMBER}]</a>&QUOT;</p>""",
-                recipientProviders: [[$class: 'DevelopersRecipientProvider']]
-            )
+            sh 'docker system prune -a -f'
         }
     }
 }

Makefile

@@ -0,0 +1,17 @@
+.PHONY: help pull build clean
+.DEFAULT_GOAL: build
+
+help:
+	@echo "make pull"
+	@echo "       Start docker container with pull"
+	@echo "make build"
+	@echo "       Start docker container rebuilding container"
+
+pull:
+	docker-compose up
+
+build:
+	docker-compose -f docker-compose_dev.yml up --build
+
+clean:
+	docker system prune -a

PlexBot/__init__.py

@@ -1,3 +1,9 @@
+"""
+Plex music bot for discord.
+
+Do not import this module, it is intended to be
+used exclusively within a docker environment.
+"""
 import logging
 import sys
 from pathlib import Path
@@ -8,19 +14,33 @@ import yaml
 FORMAT = "%(asctime)s %(levelname)s: [%(filename)s:%(lineno)s - %(funcName)20s() ] %(message)s"
 
 logging.basicConfig(format=FORMAT)
-logger = logging.getLogger("PlexBot")
+root_log = logging.getLogger()
+plex_log = logging.getLogger("Plex")
+bot_log = logging.getLogger("Bot")
 
 
 def load_config(filename: str) -> Dict[str, str]:
+    """Loads config from yaml file
 
+    Grabs key/value config pairs from a file.
+
+    Args:
+        filename: str path to yaml file.
+
+    Returns:
+        Dict[str, str] Values from config file.
+
+    Raises:
+        FileNotFound Configuration file not found.
+    """
     # All config files should be in /config
     # for docker deployment.
     filename = Path("/config", filename)
     try:
-        with open(filename, "r") as f:
-            config = yaml.safe_load(f)
+        with open(filename, "r") as config_file:
+            config = yaml.safe_load(config_file)
     except FileNotFoundError:
-        logging.fatal("Configuration file not found.")
+        root_log.fatal("Configuration file not found.")
         sys.exit(-1)
 
     # Convert str level type to logging constant
@@ -31,7 +51,12 @@ def load_config(filename: str) -> Dict[str, str]:
         "ERROR": logging.ERROR,
         "CRITICAL": logging.CRITICAL,
     }
-    level = config["general"]["log_level"]
-    config["general"]["log_level"] = levels[level.upper()]
+
+    config["root"]["log_level"] = levels[config["root"]["log_level"].upper()]
+    config["plex"]["log_level"] = levels[config["plex"]["log_level"].upper()]
+    config["discord"]["log_level"] = levels[config["discord"]["log_level"].upper()]
+
+    if config["lyrics"]["token"].lower() == "none":
+        config["lyrics"]["token"] = None
 
     return config

PlexBot/__main__.py

@@ -1,11 +1,14 @@
+"""
+Main entrypoint script.
+Sets up loggers and initiates bot.
+"""
 import logging
 
 from discord.ext.commands import Bot
 
-from . import FORMAT
+from . import load_config
 from .bot import General
 from .bot import Plex
-from PlexBot import load_config
 
 # Load config from file
 config = load_config("config.yaml")
@@ -16,14 +19,27 @@ TOKEN = config["discord"]["token"]
 BASE_URL = config["plex"]["base_url"]
 PLEX_TOKEN = config["plex"]["token"]
 LIBRARY_NAME = config["plex"]["library_name"]
-LOG_LEVEL = config["general"]["log_level"]
+
+LYRICS_TOKEN = config["lyrics"]["token"]
 
 # Set appropiate log level
-logger = logging.getLogger("PlexBot")
-logging.basicConfig(format=FORMAT)
-logger.setLevel(LOG_LEVEL)
+root_log = logging.getLogger()
+plex_log = logging.getLogger("Plex")
+bot_log = logging.getLogger("Bot")
+
+plex_log.setLevel(config["plex"]["log_level"])
+bot_log.setLevel(config["discord"]["log_level"])
+
+plex_args = {
+    "base_url": BASE_URL,
+    "plex_token": PLEX_TOKEN,
+    "lib_name": LIBRARY_NAME,
+    "lyrics_token": LYRICS_TOKEN,
+}
 
 bot = Bot(command_prefix=BOT_PREFIX)
+# Remove help command, we have our own custom one.
+bot.remove_command("help")
 bot.add_cog(General(bot))
-bot.add_cog(Plex(bot, BASE_URL, PLEX_TOKEN, LIBRARY_NAME, BOT_PREFIX))
+bot.add_cog(Plex(bot, **plex_args))
 bot.run(TOKEN)

PlexBot/__version__.py

@@ -0,0 +1,5 @@
+"""Track version number of package."""
+VERSION = "1.0.2"
+
+if __name__ == "__main__":
+    print(VERSION)

PlexBot/bot.py

@@ -1,127 +1,354 @@
+"""All discord bot and Plex api interactions."""
 import asyncio
 import io
 import logging
 from urllib.request import urlopen
 
 import discord
+import lyricsgenius
 from async_timeout import timeout
 from discord import FFmpegPCMAudio
 from discord.ext import commands
 from discord.ext.commands import command
-from fuzzywuzzy import fuzz
 from plexapi.exceptions import Unauthorized
 from plexapi.server import PlexServer
 
-logger = logging.getLogger("PlexBot")
+from .exceptions import MediaNotFoundError
+from .exceptions import VoiceChannelError
+
+root_log = logging.getLogger()
+plex_log = logging.getLogger("Plex")
+bot_log = logging.getLogger("Bot")
+
+help_text = """
+General:
+    kill [silent] - Halt the bot [silently].
+    help - Print this help message.
+    cleanup - Delete old messages from the bot.
+
+Plex:
+    play <SONG_NAME> - Play a song from the plex server.
+    album <ALBUM_NAME> - Queue an entire album to play.
+    lyrics - Print the lyrics of the song (Requires Genius API)
+    np - Print the current playing song.
+    stop - Halt playback and leave vc.
+    pause - Pause playback.
+    resume - Resume playback.
+    clear - Clear play queue.
+
+[] - Optional args.
+"""
 
 
 class General(commands.Cog):
+    """General commands
+
+    Manage general bot behavior
+    """
+
     def __init__(self, bot):
+        """Initialize commands
+
+        Args:
+            bot: discord.ext.command.Bot, bind for cogs
+
+        Returns:
+            None
+
+        Raises:
+            None
+        """
         self.bot = bot
 
     @command()
-    async def kill(self, ctx):
-        await ctx.send(f"Stopping upon the request of {ctx.author.mention}")
+    async def kill(self, ctx, *args):
+        """Kill the bot
+
+        Args:
+            ctx: discord.ext.commands.Context message context from command
+            *args: optional flags
+
+        Returns:
+            None
+
+        Raises:
+            None
+        """
+        if "silent" not in args:
+            await ctx.send(f"Stopping upon the request of {ctx.author.mention}")
+
         await self.bot.close()
-        logger.info(f"Stopping upon the request of {ctx.author.mention}")
+        bot_log.info("Stopping upon the request of %s", ctx.author.mention)
+
+    @command(name="help")
+    async def help(self, ctx):
+        """Prints command help
+
+        Args:
+            ctx: discord.ext.commands.Context message context from command
+
+        Returns:
+            None
+
+        Raise:
+            None
+        """
+
+        await ctx.send(f"```{help_text}```")
+
+    @command()
+    async def cleanup(self, ctx, limit=250):
+        """Delete old messages from bot
+
+        Args:
+            ctx: discord.ext.commands.Context message context from command
+            limit: int number of messages to go back by to delete. Default 250
+
+        Raises:
+            None
+
+        Returns:
+            None
+        """
+        channel = ctx.message.channel
+
+        try:
+            async for i in channel.history(limit=limit):
+                # Only delete messages sent by self
+                if i.author == self.bot.user:
+                    try:
+                        await i.delete()
+                    except (discord.Forbidden, discord.NotFound, discord.HTTPException):
+                        pass
+
+            async for i in channel.history(limit=limit):
+                if i.author == ctx.message.author and i.content.startswith(
+                    self.bot.command_prefix
+                ):
+                    try:
+                        await i.delete()
+                    except (discord.Forbidden, discord.NotFound, discord.HTTPException):
+                        pass
+
+        except discord.Forbidden:
+            bot_log.info("Unable to delete messages, insufficient permissions.")
+            await ctx.send("I don't have the necessary permissions to delete messages.")
 
 
 class Plex(commands.Cog):
-    def __init__(self, bot, base_url, plex_token, lib_name, bot_prefix) -> None:
-        self.bot = bot
-        self.base_url = base_url
-        self.plex_token = plex_token
-        self.library_name = lib_name
-        self.bot_prefix = bot_prefix
+    """
+    Discord commands pertinent to interacting with Plex
 
+    Contains user commands such as play, pause, resume, stop, etc.
+    Grabs, and parses all data from plex database.
+    """
+
+    # pylint: disable=too-many-instance-attributes
+    # All are necessary to detect global interactions
+    # within the bot.
+
+    def __init__(self, bot, **kwargs):
+        """Initializes Plex resources
+
+        Connects to Plex library and sets up
+        all asyncronous communications.
+
+        Args:
+            bot: discord.ext.command.Bot, bind for cogs
+            base_url: str url to Plex server
+            plex_token: str X-Token of Plex server
+            lib_name: str name of Plex library to search through
+
+        Raises:
+            plexapi.exceptions.Unauthorized: Invalid Plex token
+
+        Returns:
+            None
+        """
+
+        self.bot = bot
+        self.base_url = kwargs["base_url"]
+        self.plex_token = kwargs["plex_token"]
+        self.library_name = kwargs["lib_name"]
+        self.bot_prefix = bot.command_prefix
+
+        if kwargs["lyrics_token"]:
+            self.genius = lyricsgenius.Genius(kwargs["lyrics_token"])
+        else:
+            plex_log.warning("No lyrics token specified, lyrics disabled")
+            self.genius = None
+
+        # Log fatal invalid plex token
         try:
             self.pms = PlexServer(self.base_url, self.plex_token)
         except Unauthorized:
-            logger.fatal("Invalid Plex token, stopping...")
+            plex_log.fatal("Invalid Plex token, stopping...")
             raise Unauthorized("Invalid Plex token")
 
         self.music = self.pms.library.section(self.library_name)
+        plex_log.debug("Connected to plex library: %s", self.library_name)
 
-        self.vc = None
+        # Initialize necessary vars
+        self.voice_channel = None
         self.current_track = None
+        self.np_message_id = None
+        self.ctx = None
+
+        # Initialize events
         self.play_queue = asyncio.Queue()
         self.play_next_event = asyncio.Event()
 
+        bot_log.info("Started bot successfully")
         self.bot.loop.create_task(self._audio_player_task())
 
-        logger.info("Started bot successfully")
+    def _search_tracks(self, title: str):
+        """Search the Plex music db for track
 
-    def _search_tracks(self, title):
-        tracks = self.music.searchTracks()
-        score = [None, -1]
-        for i in tracks:
-            s = fuzz.ratio(title.lower(), i.title.lower())
-            if s > score[1]:
-                score[0] = i
-                score[1] = s
-            elif s == score[1]:
-                score[0] = i
+        Args:
+            title: str title of song to search for
 
-        return score[0]
+        Returns:
+            plexapi.audio.Track pointing to best matching title
 
-    @command()
-    async def hello(self, ctx, *, member: discord.member = None):
-        member = member or ctx.author
-        await ctx.send(f"Hello {member}")
+        Raises:
+            MediaNotFoundError: Title of track can't be found in plex db
+        """
+        results = self.music.searchTracks(title=title, maxresults=1)
+        try:
+            return results[0]
+        except IndexError:
+            raise MediaNotFoundError("Track cannot be found")
+
+    def _search_albums(self, title: str):
+        """Search the Plex music db for album
+
+        Args:
+            title: str title of album to search for
+
+        Returns:
+            plexapi.audio.Album pointing to best matching title
+
+        Raises:
+            MediaNotFoundError: Title of album can't be found in plex db
+        """
+        results = self.music.searchAlbums(title=title, maxresults=1)
+        try:
+            return results[0]
+        except IndexError:
+            raise MediaNotFoundError("Album cannot be found")
 
     async def _play(self):
+        """Heavy lifting of playing songs
+
+        Grabs the appropiate streaming URL, sends the `now playing`
+        message, and initiates playback in the vc.
+
+        Args:
+            None
+
+        Returns:
+            None
+
+        Raises:
+            None
+        """
         track_url = self.current_track.getStreamURL()
         audio_stream = FFmpegPCMAudio(track_url)
 
-        while self.vc.is_playing():
+        while self.voice_channel.is_playing():
             asyncio.sleep(2)
 
-        self.vc.play(audio_stream, after=self._toggle_next)
+        self.voice_channel.play(audio_stream, after=self._toggle_next)
 
-        logger.debug(f"Playing {self.current_track.title}")
-        logger.debug(f"URL: {track_url}")
+        plex_log.debug("%s - URL: %s", self.current_track, track_url)
 
-        embed, f = self._build_embed(self.current_track)
-        await self.ctx.send(embed=embed, file=f)
+        embed, img = self._build_embed_track(self.current_track)
+        self.np_message_id = await self.ctx.send(embed=embed, file=img)
 
     async def _audio_player_task(self):
+        """Coroutine to handle playback and queuing
+
+        Always-running function awaiting new songs to be added.
+        Auto disconnects from VC if idle for > 15 seconds.
+        Handles auto deletion of now playing song notifications.
+
+        Args:
+            None
+
+        Returns:
+            None
+
+        Raises:
+            None
+        """
         while True:
             self.play_next_event.clear()
-            if self.vc:
+            if self.voice_channel:
                 try:
                     # Disconnect after 15 seconds idle
                     async with timeout(15):
                         self.current_track = await self.play_queue.get()
                 except asyncio.TimeoutError:
-                    await self.vc.disconnect()
-                    self.vc = None
+                    await self.voice_channel.disconnect()
+                    self.voice_channel = None
 
             if not self.current_track:
                 self.current_track = await self.play_queue.get()
 
             await self._play()
             await self.play_next_event.wait()
+            await self.np_message_id.delete()
 
     def _toggle_next(self, error=None):
+        """Callback for vc playback
+
+        Clears current track, then activates _audio_player_task
+        to play next in queue or disconnect.
+
+        Args:
+            error: Optional parameter required for discord.py callback
+
+        Returns:
+            None
+
+        Raises:
+            None
+        """
         self.current_track = None
         self.bot.loop.call_soon_threadsafe(self.play_next_event.set)
 
-    def _build_embed(self, track, t="play"):
-        """Creates a pretty embed card.
+    @staticmethod
+    def _build_embed_track(track, type_="play"):
+        """Creates a pretty embed card for tracks
+
+        Builds a helpful status embed with the following info:
+        Status, song title, album, artist and album art. All
+        pertitent information is grabbed dynamically from the Plex db.
+
+        Args:
+            track: plexapi.audio.Track object of song
+            type_: Type of card to make (play, queue).
+
+        Returns:
+            embed: discord.embed fully constructed payload.
+            thumb_art: io.BytesIO of album thumbnail img.
+
+        Raises:
+            ValueError: Unsupported type of embed {type_}
         """
         # Grab the relevant thumbnail
         img_stream = urlopen(track.thumbUrl)
         img = io.BytesIO(img_stream.read())
 
         # Attach to discord embed
-        f = discord.File(img, filename="image0.png")
+        art_file = discord.File(img, filename="image0.png")
         # Get appropiate status message
-        if t == "play":
+        if type_ == "play":
             title = f"Now Playing - {track.title}"
-        elif t == "queue":
+        elif type_ == "queue":
             title = f"Added to queue - {track.title}"
         else:
-            raise ValueError(f"Unsupported type of embed {t}")
+            raise ValueError(f"Unsupported type of embed {type_}")
 
         # Include song details
         descrip = f"{track.album().title} - {track.artist().title}"
@@ -134,77 +361,325 @@ class Plex(commands.Cog):
         # Point to file attached with ctx object.
         embed.set_thumbnail(url="attachment://image0.png")
 
-        return embed, f
+        bot_log.debug("Built embed for track - %s", track.title)
+
+        return embed, art_file
+
+    @staticmethod
+    def _build_embed_album(album):
+        """Creates a pretty embed card for albums
+
+        Builds a helpful status embed with the following info:
+        album, artist, and album art. All pertitent information
+        is grabbed dynamically from the Plex db.
+
+        Args:
+            album: plexapi.audio.Album object of album
+
+        Returns:
+            embed: discord.embed fully constructed payload.
+            thumb_art: io.BytesIO of album thumbnail img.
+
+        Raises:
+            None
+        """
+        # Grab the relevant thumbnail
+        img_stream = urlopen(album.thumbUrl)
+        img = io.BytesIO(img_stream.read())
+
+        # Attach to discord embed
+        art_file = discord.File(img, filename="image0.png")
+        title = "Added album to queue"
+        descrip = f"{album.title} - {album.artist().title}"
+
+        embed = discord.Embed(
+            title=title, description=descrip, colour=discord.Color.red()
+        )
+        embed.set_author(name="Plex")
+        embed.set_thumbnail(url="attachment://image0.png")
+        bot_log.debug("Built embed for album - %s", album.title)
+
+        return embed, art_file
+
+    async def _validate(self, ctx):
+        """Ensures user is in a vc
+
+        Args:
+            ctx: discord.ext.commands.Context message context from command
+
+        Returns:
+            None
+
+        Raises:
+            VoiceChannelError: Author not in voice channel
+        """
+        # Fail if user not in vc
+        if not ctx.author.voice:
+            await ctx.send("Join a voice channel first!")
+            bot_log.debug("Failed to play, requester not in voice channel")
+            raise VoiceChannelError
+
+        # Connect to voice if not already
+        if not self.voice_channel:
+            self.voice_channel = await ctx.author.voice.channel.connect()
+            bot_log.debug("Connected to vc.")
 
     @command()
     async def play(self, ctx, *args):
+        """User command to play song
 
-        if not len(args):
-            await ctx.send(f"Usage: {self.bot_prefix}play TITLE_OF_SONG")
-            return
+        Searchs plex db and either, initiates playback, or
+        adds to queue. Handles invalid usage from the user.
 
-        title = " ".join(args)
-        track = self._search_tracks(title)
+        Args:
+            ctx: discord.ext.commands.Context message context from command
+            *args: Title of song to play
 
-        # Fail if song title can't be found
-        if not track:
-            await ctx.send(f"Can't find song: {title}")
-            return
-        # Fail if user not in vc
-        elif not ctx.author.voice:
-            await ctx.send("Join a voice channel first!")
-            return
-
-        # Connect to voice if not already
-        if not self.vc:
-            self.vc = await ctx.author.voice.channel.connect()
-            logger.debug("Connected to vc.")
-
-        # Specific add to queue message
-        if self.vc.is_playing():
-            embed, f = self._build_embed(track, t="queue")
-            await ctx.send(embed=embed, file=f)
+        Returns:
+            None
 
+        Raises:
+            None
+        """
         # Save the context to use with async callbacks
         self.ctx = ctx
+        title = " ".join(args)
+
+        try:
+            track = self._search_tracks(title)
+        except MediaNotFoundError:
+            await ctx.send(f"Can't find song: {title}")
+            bot_log.debug("Failed to play, can't find song - %s", title)
+            return
+
+        try:
+            await self._validate(ctx)
+        except VoiceChannelError:
+            pass
+
+        # Specific add to queue message
+        if self.voice_channel.is_playing():
+            bot_log.debug("Added to queue - %s", title)
+            embed, img = self._build_embed_track(track, type_="queue")
+            await ctx.send(embed=embed, file=img)
+
         # Add the song to the async queue
         await self.play_queue.put(track)
 
+    @command()
+    async def album(self, ctx, *args):
+        """User command to play song
+
+        Searchs plex db and either, initiates playback, or
+        adds to queue. Handles invalid usage from the user.
+
+        Args:
+            ctx: discord.ext.commands.Context message context from command
+            *args: Title of song to play
+
+        Returns:
+            None
+
+        Raises:
+            None
+        """
+        # Save the context to use with async callbacks
+        self.ctx = ctx
+        title = " ".join(args)
+
+        try:
+            album = self._search_albums(title)
+        except MediaNotFoundError:
+            await ctx.send(f"Can't find album: {title}")
+            bot_log.debug("Failed to queue album, can't find - %s", title)
+            return
+
+        try:
+            await self._validate(ctx)
+        except VoiceChannelError:
+            pass
+
+        bot_log.debug("Added to queue - %s", title)
+        embed, img = self._build_embed_album(album)
+        await ctx.send(embed=embed, file=img)
+
+        for track in album.tracks():
+            await self.play_queue.put(track)
+
     @command()
     async def stop(self, ctx):
-        if self.vc:
-            self.vc.stop()
-            await self.vc.disconnect()
-            self.vc = None
+        """User command to stop playback
+
+        Stops playback and disconnects from vc.
+
+        Args:
+            ctx: discord.ext.commands.Context message context from command
+
+        Returns:
+            None
+
+        Raises:
+            None
+        """
+        if self.voice_channel:
+            self.voice_channel.stop()
+            await self.voice_channel.disconnect()
+            self.voice_channel = None
             self.ctx = None
+            bot_log.debug("Stopped")
             await ctx.send(":stop_button: Stopped")
 
     @command()
     async def pause(self, ctx):
-        if self.vc:
-            self.vc.pause()
+        """User command to pause playback
+
+        Pauses playback, but doesn't reset anything
+        to allow playback resuming.
+
+        Args:
+            ctx: discord.ext.commands.Context message context from command
+
+        Returns:
+            None
+
+        Raises:
+            None
+        """
+        if self.voice_channel:
+            self.voice_channel.pause()
+            bot_log.debug("Paused")
             await ctx.send(":play_pause: Paused")
 
     @command()
     async def resume(self, ctx):
-        if self.vc:
-            self.vc.resume()
+        """User command to resume playback
+
+        Args:
+            ctx: discord.ext.commands.Context message context from command
+
+        Returns:
+            None
+
+        Raises:
+            None
+        """
+        if self.voice_channel:
+            self.voice_channel.resume()
+            bot_log.debug("Resumed")
             await ctx.send(":play_pause: Resumed")
 
     @command()
     async def skip(self, ctx):
-        logger.debug("Skip")
-        if self.vc:
-            self.vc.stop()
+        """User command to skip song in queue
+
+        Skips currently playing song. If no other songs in
+        queue, stops playback, otherwise moves to next song.
+
+        Args:
+            ctx: discord.ext.commands.Context message context from command
+
+        Returns:
+            None
+
+        Raises:
+            None
+        """
+        bot_log.debug("Skip")
+        if self.voice_channel:
+            self.voice_channel.stop()
+            bot_log.debug("Skipped")
             self._toggle_next()
 
-    @command()
-    async def np(self, ctx):
+    @command(name="np")
+    async def now_playing(self, ctx):
+        """User command to get currently playing song.
+
+        Deletes old `now playing` status message,
+        Creates a new one with up to date information.
+
+        Args:
+            ctx: discord.ext.commands.Context message context from command
+
+        Returns:
+            None
+
+        Raises:
+            None
+        """
         if self.current_track:
-            embed, f = self._build_embed(self.current_track)
-            await ctx.send(embed=embed, file=f)
+            embed, img = self._build_embed_track(self.current_track)
+            bot_log.debug("Now playing")
+            if self.np_message_id:
+                await self.np_message_id.delete()
+                bot_log.debug("Deleted old np status")
+
+            bot_log.debug("Created np status")
+            self.np_message_id = await ctx.send(embed=embed, file=img)
 
     @command()
     async def clear(self, ctx):
+        """User command to clear play queue.
+
+        Args:
+            ctx: discord.ext.commands.Context message context from command
+
+        Returns:
+            None
+
+        Raises:
+            None
+        """
         self.play_queue = asyncio.Queue()
+        bot_log.debug("Cleared queue")
         await ctx.send(":boom: Queue cleared.")
+
+    @command()
+    async def lyrics(self, ctx):
+        """User command to get lyrics of a song.
+
+        Args:
+            ctx: discord.ext.commands.Context message context from command
+
+            Returns:
+                None
+
+            Raises:
+                None
+        """
+        if not self.current_track:
+            plex_log.info("No song currently playing")
+            return
+
+        if self.genius:
+            plex_log.info(
+                "Searching for %s, %s",
+                self.current_track.title,
+                self.current_track.artist().title,
+            )
+            try:
+                song = self.genius.search_song(
+                    self.current_track.title, self.current_track.artist().title
+                )
+            except TypeError:
+                self.genius = None
+                plex_log.error("Invalid genius token, disabling lyrics")
+                return
+
+            try:
+                lyrics = song.lyrics
+                # Split into 1950 char chunks
+                # Discord max message length is 2000
+                lines = [(lyrics[i : i + 1950]) for i in range(0, len(lyrics), 1950)]
+
+                for i in lines:
+                    if i == "":
+                        continue
+                    # Apply code block format
+                    i = f"```{i}```"
+                    await ctx.send(i)
+
+            except (IndexError, TypeError):
+                plex_log.info("Could not find lyrics")
+                await ctx.send("Can't find lyrics for this song.")
+        else:
+            plex_log.warning("Attempted lyrics without valid token")

PlexBot/exceptions.py

@@ -0,0 +1,10 @@
+class MediaNotFoundError(Exception):
+    """Raised when a PlexAPI media resource cannot be found."""
+
+    pass
+
+
+class VoiceChannelError(Exception):
+    """Raised when user is not connected to a voice channel."""
+
+    pass

README.md

@@ -1,28 +1,71 @@
 # Plex-Bot
 
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/c93b8ff976ce4205a95046487917476b)](https://app.codacy.com/manual/jarulsamy/Plex-Bot?utm_source=github.com&utm_medium=referral&utm_content=jarulsamy/Plex-Bot&utm_campaign=Badge_Grade_Dashboard)
+[![GPLv3 license](https://img.shields.io/badge/License-GPLv3-blue.svg)](http://perso.crans.org/besson/LICENSE.html)
+![docker pulls](https://img.shields.io/docker/pulls/jarulsamy/plex-bot)
+![docker img size](https://img.shields.io/docker/image-size/jarulsamy/plex-bot)
+![black badge](https://img.shields.io/badge/code%20style-black-000000.svg)
+
 A Python-based Plex music bot for discord.
 
+![screenshot](assets/screenshot.png)
+
 ## Setup
 
 Plex-Bot runs entirely in a Docker container. Ensure you have Docker and docker-compose installed according to the official Docker [documentation](https://docs.docker.com/get-docker/).
 
-1.  Clone the repository and `cd` into it:
+1. Create a new folder and `cd` into it:
 
-```
-$ git clone https://github.com/jarulsamy/Plex-Bot
-$ cd Plex-Bot
-```
+   ```bash
+   mkdir Plex-Bot
+   cd Plex-Bot
+   ```
 
-2. Create a configuration folder:
+2. Make a `docker-compose.yml` file or use this sample:
 
-Create a new `config` folder and copy the sample config file into it:
+   ```yml
+   version: "3"
+   services:
+     plex-bot:
+       container_name: "PlexBot"
+       image: jarulsamy/plex-bot:latest
+       environment:
+         - PUID=1000
+         - PGID=1000
+         - TZ=America/Denver
+       # Required dir for configuration files
+       volumes:
+         - "./config:/config:ro"
+       restart: "unless-stopped"
+   ```
 
-```
-$ mkdir config
-$ cp sample-config.yaml config/config.yaml
-```
+3. Create a new `config` folder and create a config file like this::
 
-3.  Create a Discord bot application:
+    ```bash
+    mkdir config
+    cd config
+    touch config.yaml
+    ```
+
+   ```yml
+   # Create a file called config.yaml with the following contents
+
+   root:
+     log_level: "info"
+
+   discord:
+     prefix: "?"
+     token: "<BOT_TOKEN>"
+     log_level: "debug"
+
+   plex:
+     base_url: "<BASE_URL>"
+     token: "<PLEX_TOKEN>"
+     library_name: "<LIBRARY_NAME>"
+     log_level: "debug"
+   ```
+
+4. Create a Discord bot application:
 
     1. Go to the Discord developer portal, [here](https://discord.com/developers/applications).
 
@@ -38,44 +81,70 @@ $ cp sample-config.yaml config/config.yaml
     6. Click Create Bot User
         This will provide you with your bot Username and Token
 
-    7. Fill in all the necessary numbers in `config/config.yaml`
+    7. Fill in the bot token in `config/config.yaml`
 
-4. Get your plex token:
+5. Get your plex token:
 
-   Refer to the official [plex documentation](https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/).
+     * Refer to the official [plex documentation](https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/).
 
-   Add it to `config/config.yaml` in the appropiate spot.
+     * Add it to `config/config.yaml` in the appropiate spot.
 
-5. Start the service:
+6. Get your Lyrics Genius token (Optional):
 
-```
-$ docker-compose up --build
+   If you wanty to disable this feature, set token to `None` in `config/config.yaml`
+
+   If you would like to enable the lyrics feature of the bot, you need to signup for a free GeniusLyrics account, [here](https://genius.com/api-clients).
+
+   After you make an account:
+
+   1. Click New API Client
+
+   2. Set the app website url to: `https://github.com/jarulsamy/Plex-Bot`
+
+   3. Set the redirect url to: `http://localhost`
+
+   4. Copy the **Client Access Token** to `config/config.yaml`
+
+7. Customize remaining settings
+
+    Set any remaining settings in the config file that you would like. Such as music library, and base url of the Plex server.
+
+8. Start the service:
+
+   ```bash
+   docker-compose up -d
+   ```
+
+## Logs
+
+You can view the logs with the following command
+
+```bash
+docker-compose logs -f CONTAINER_NAME_OR_ID
+
+# For example
+docker-compose logs -f PlexBot
 ```
 
 ## Usage
 
-```
+```text
 General:
-  kill - Stop the bot.
+    kill [silent] - Halt the bot [silently].
+    help - Print this help message.
+    cleanup - Delete old messages from the bot.
+
 Plex:
-  np - View currently playing song.
-  pause - Pause currently playing song.
-  play - Play a song from the Plex library.
-  resume - Resume a paused song.
-  skip - Skip a song.
-  stop - Stop playing.
-​No Category:
-  help   Shows this message
+    play <SONG_NAME> - Play a song from the plex server.
+    album <ALBUM_NAME> - Queue an entire album to play.
+    lyrics - Print the lyrics of the song (Requires Genius API)
+    np - Print the current playing song.
+    stop - Halt playback and leave vc.
+    pause - Pause playback.
+    resume - Resume playback.
+    clear - Clear play queue.
 
-Type ?help command for more info on a command.
-You can also type ?help category for more info on a category.
+[] - Optional args.
 ```
 
-## Support
-
-Reach out to me at one of the following places!
-
--   Email (Best) at joshua.gf.arul@gmail.com
--   Twitter at <a href="http://twitter.com/jarulsamy_" target="_blank">`@jarulsamy_`</a>
-
 * * *

deploy/build.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+VERSION=$(python PlexBot/__version__.py)
+
+docker build -t "jarulsamy/plex-bot:$VERSION" .
+
+if [ $? -eq 0 ]
+then
+  echo "Successfully build docker image."
+  exit 0
+else
+  echo "Failed to build docker image." >&2
+  exit 1
+fi

deploy/push.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+VERSION=$(python PlexBot/__version__.py)
+
+docker push "jarulsamy/plex-bot:$VERSION"
+
+if [ $? -eq 0 ]
+then
+  echo "Successfully pushed docker image."
+  exit 0
+else
+  echo "Failed to push docker image." >&2
+  exit 1
+fi

docker-compose.yml

@@ -2,7 +2,7 @@ version: "3"
 services:
   plex-bot:
     container_name: "PlexBot"
-    build: .
+    image: jarulsamy/plex-bot:latest
     environment:
       - PUID=1000
       - PGID=1000
@@ -10,4 +10,4 @@ services:
     # Required dir for configuration files
     volumes:
       - "./config:/config:ro"
-    restart: "no"
+    restart: "unless-stopped"

docker-compose_dev.yml

@@ -0,0 +1,13 @@
+version: "3"
+services:
+  plex-bot:
+    container_name: "PlexBot"
+    build: .
+    environment:
+      - PUID=1000
+      - PGID=1000
+      - TZ=America/Denver
+    # Required dir for configuration files
+    volumes:
+      - "./config:/config:ro"
+    restart: "no"

requirements.txt

@@ -1,7 +1,7 @@
 discord.py==1.3.4
 PlexAPI==4.0.0
 fuzzywuzzy==0.18.0
-python-Levenshtein==0.12.0
 pynacl==1.4.0
 ffmpeg==1.4
 PyYAML==5.3.1
+lyricsgenius==2.0.0

sample-config.yaml

@@ -1,12 +1,16 @@
-general:
-  # Options: debug, info, warning, error, critical
+root:
   log_level: "info"
 
 discord:
   prefix: "?"
   token: "<BOT_TOKEN>"
+  log_level: "debug"
 
 plex:
   base_url: "<BASE_URL>"
   token: "<PLEX_TOKEN>"
   library_name: "<LIBRARY_NAME>"
+  log_level: "debug"
+
+lyrics:
+  token: <CLIENT_ACCESS_TOKEN>