Add a changelog command

Author: kyb3r

CHANGELOG.md

@@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+# [unreleased]
+### Added 
+
 # v2.0.6
 
 ### Fixed

cogs/utility.py

@@ -10,6 +10,7 @@
 
 from core.paginator import PaginatorSession
 from core.decorators import auth_required, owner_only, trigger_typing
+from core.changelog import ChangeLog
 
 
 class Utility:
@@ -151,6 +152,13 @@ async def help(self, ctx, *, command: str=None):
         p_session = PaginatorSession(ctx, *pages)
 
         await p_session.run()
+    
+    @commands.command()
+    @trigger_typing
+    async def changelog(self, ctx):
+        changelog = await ChangeLog.from_repo(self.bot)
+        p = PaginatorSession(ctx, *changelog.embeds)
+        await p.run()
 
     @commands.command()
     @trigger_typing

core/changelog.py

@@ -1,8 +1,11 @@
 from collections import defaultdict
 import re 
 
+import discord
+
 class Version:
-    def __init__(self, version, lines):
+    def __init__(self, bot, version, lines):
+        self.bot = bot 
         self.version = version
         self.lines = [x for x in lines.splitlines() if x]
         self.fields = defaultdict(str)
@@ -21,20 +24,45 @@ def parse(self):
                 self.description += line + '\n'
             else:
                 self.fields[curr_action] += line + '\n'
-        
-class ChangeLogParser:
+    
+    @property
+    def embed(self):
+        em = discord.Embed(color=discord.Color.green(), description=self.description)
+        em.set_author(
+            name=f'{self.version} - Changelog', 
+            icon_url=self.bot.user.avatar_url, 
+            url='https://modmail.tk/changelog'
+            )
+        for name, value in self.fields.items():
+            em.add_field(name=name, value=value)
+        em.set_footer(text=f'Current version: v{self.bot.version}')
+        return em
+
+class ChangeLog:
+
+    changelog_url = 'https://raw.githubusercontent.com/kyb3r/modmail/master/CHANGELOG.md'
     regex = re.compile(r'# (v\d\.\d\.\d)([\S\s]*?(?=# v))')
 
-    def __init__(self, text):
+    def __init__(self, bot, text):
+        self.bot = bot 
         self.text = text 
-        self.versions = [Version(*m) for m in self.regex.findall(text)]
+        self.versions = [Version(bot, *m) for m in self.regex.findall(text)]
 
     @property
     def latest_version(self):
         return self.versions[0]
 
-
+    @property
+    def embeds(self):
+        return [v.embed for v in self.versions]
+    
+    @classmethod
+    async def from_repo(cls, bot, url=None):
+        url = url or cls.changelog_url
+        resp = await bot.session.get(url)
+        return cls(bot, await resp.text())
+    
 if __name__ == '__main__':
     with open('../CHANGELOG.md') as f:
-        changelog = ChangeLogParser(f.read())
+        changelog = ChangeLog(f.read())
         print(changelog.latest_version)