Reworked Pymon to Use a SQLite Database on the Backend (#21)

* Updated requirements file

* Reworked directory structure

* Removed unused intents

* Performed some light formatting

* Building out brain

* Fully developed brain layout

* Added the brain to pymon

* Removed references to client

* Changed code to use FTS5

* Removed logs

* Migrated authors

* Author ID mapping works

* Code works!

* Working through database stuff

* Remove file

* Fully migrated old data

* Added resources and authors

* Reworked search to return exactly what I want

* React on mention is up to speed

* Removed old functions

* Removed refresh command

* Fixed up the get command

* Fixed up the tags issue

* Cleaned up brain code

* Patched up all existing features

* Cleaned up code

* Removed old tests

* Cleaning up existing files

* Reworked readme code

* Added the new query feature

* Added missing comments

* Fixed an issue with the new command

* Added two more queries

* Added one more query

* Removed python workflow

Author: jrg94

.env.test_type_0

@@ -127,3 +127,9 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# Database files
+*.db
+
+# Logs
+/logs

.env.test_type_1

@@ -40,18 +40,18 @@ Currently, the bot can answer the following questions. The numbers map directly
 2. "What is a primitive type?" by Jeremy Grifski
 3. "How can I create a constant?" by Jeremy Grifski
 4. "What is testing?" by Jeremy Grifski
-5. "What is debugging?" by Jeremy Grifski, Xining Feng
+5. "What is debugging?" by Xining Feng, Jeremy Grifski
 6. "What is correctness?" by Jeremy Grifski
 7. "What is JUnit?" by Jeremy Grifski
 8. "What is unit testing?" by Jeremy Grifski
 9. "What is an expression tree?" by Jeremy Grifski
 10. "What is confidence building?" by Jeremy Grifski
 11. "What is the declared type of a variable?" by Jeremy Grifski
 12. "What is the static type of a variable?" by Jeremy Grifski
-13. "What is method overriding?" by Jeremy Grifski, Le Chang, Zihe Fang, Alexia Scarvelli, Tae Yeon Kim
+13. "What is method overriding?" by Jeremy Grifski, Alexia Scarvelli, Zihe Fang, Tae Yeon Kim, Le Chang
 14. "What is method overloading?" by Jeremy Grifski
-15. "What is the implements relationship?" by Jeremy Grifski, Yibo Gan
-16. "What is the extends relationship?" by Jeremy Grifski, Yi-You (Joseph) Chiu
+15. "What is the implements relationship?" by Yibo Gan, Jeremy Grifski
+16. "What is the extends relationship?" by Yi-You (Joseph) Chiu, Jeremy Grifski
 17. "What is a mathematical string?" by Jeremy Grifski
 18. "What is mathematical string notation for concatenation?" by Jeremy Grifski
 19. "What is a parameter mode?" by Jeremy Grifski
@@ -77,7 +77,7 @@ Currently, the bot can answer the following questions. The numbers map directly
 39. "What is the purpose of the queue data structure?" by Ying Liang
 40. "What is Recursion?" by Gani Sagiev, Tim Keck
 41. "What is the difference between unit and integration testing?" by Jacob Kolaczkowski
-42. "What is the difference between testing and debugging?" by John DiFilippo, Ahmed Mohamed
+42. "What is the difference between testing and debugging?" by Ahmed Mohamed, John DiFilippo
 43. "What is object-oriented programming (OOP)?" by Felix Ji
 44. "What type of method is a JUnit test case?" by Matthew Alfieri
 45. "What is aliasing?" by Yuhang Huang
@@ -89,7 +89,7 @@ Currently, the bot can answer the following questions. The numbers map directly
 51. "What is the benefit of interval halving?" by Ashir Faruq
 52. "What is mathematical induction?" by Om Amin
 53. "What is the Set data type?" by Luke Thompson
-54. "What is the correct expression to see if an integer is odd in Java?" by Kurt Wanner, Yi-You (Joseph) Chiu
+54. "What is the correct expression to see if an integer is odd in Java?" by Yi-You (Joseph) Chiu, Kurt Wanner
 55. "What is XML?" by Tim Keck
 56. "What is mutability?" by Tim Keck
 57. "What is a comparator?" by Tim Keck
@@ -119,6 +119,9 @@ Currently, the bot can answer the following questions. The numbers map directly
 81. "What is abstraction?" by Yingqi Gao
 82. "What is the difference between interface and abstract class?" by Yingqi Gao
 83. "When should I use newInstance?" by Shivam Engineer
+84. "What is an observer pattern?" by Jayshuk Pandrangi
+85. "What is a loop invariant?" by Jayshuk Pandrangi
+86. "What is MVC?" by Yuheng Long (Simon)
 
 ---
 

.github/workflows/python-app.yml

@@ -1,193 +1,40 @@
 import logging
 import os
 import pathlib
+import sys
 from logging.handlers import RotatingFileHandler
 
-import discord
-from discord import Message
-from discord.ext import commands
-from discord_slash import SlashCommand
-from discord_slash.utils.manage_commands import create_choice, create_option
+from dotenv import load_dotenv
 
-import pymon_utils as utils
+from pymon import VERSION, bot
 
-__version__ = "0.6.0"
-
-
-# Setup logging
-logs_path = pathlib.Path(
-    os.path.abspath(os.path.dirname(__file__)),
-    "logs"
-)
-logs_path.mkdir(parents=True, exist_ok=True)
-logging.basicConfig(
-    handlers=[RotatingFileHandler(
-        logs_path / "bot.log",
+if __name__ == '__main__':
+    # Setup handler
+    log_path = pathlib.Path(os.path.abspath(os.path.dirname(__file__)), "logs")
+    log_path.mkdir(exist_ok=True, parents=True)
+    log_path = log_path / "pymon.log"
+    file_handler = RotatingFileHandler(
+        log_path,
         backupCount=10,
         maxBytes=1000000
-    )],
-    level=logging.DEBUG,
-    format='%(asctime)s,%(msecs)d %(levelname)-8s [%(filename)s:%(lineno)d] %(message)s',
-    datefmt='%Y-%m-%d:%H:%M:%S',
-)
-log = logging.getLogger(__name__)
-
-# Global variables
-client = commands.Bot(
-    command_prefix=commands.when_mentioned_or("!"),
-    activity=discord.Activity(
-        type=discord.ActivityType.listening,
-        name='student questions'
-    ),
-    status=discord.Status.idle
-)
-slash = SlashCommand(client, sync_commands=True)
-queries, keyword_mapping = utils.refresh_knowledge()
-
-
-# Discord bot code
-async def _react_on_mention(message: Message):
-    if client.user.mentioned_in(message) and not message.mention_everyone:
-        indices = utils.search(
-            keyword_mapping, utils.generate_keywords(message.content))
-        if indices:
-            reply = list()
-            reply.extend([
-                f"{utils.create_md_link(queries[i].get('resource'), queries[i].get('query'))}"
-                for i in indices[:3]
-            ])
-            embed = discord.Embed(
-                title=f"Pymon v{__version__}: Do any of these questions match your query?",
-                description="Use the ID with the /get command to get an answer or follow the available links:",
-                color=discord.Color.blue(),
-                url="https://github.com/TheRenegadeCoder/pymon"
-            )
-            for idx, row in enumerate(reply):
-                embed.add_field(
-                    name=f"#{idx + 1}: ID-{indices[idx]}",
-                    value=row,
-                    inline=True
-                )
-            embed.set_footer(
-                text="Learn more about how this bot works by clicking the title.",
-                icon_url="https://therenegadecoder.com/wp-content/uploads/2017/05/the-renegade-coder-icon-cropped.png"
-            )
-            await message.reply(embed=embed)
-        else:
-            await message.reply("How about we explore the area ahead of us later? https://tenor.com/bqnuv.gif")
-
-
-@client.event
-async def on_message(message: Message):
-    """
-    The action to be called when a message is sent.
-
-    :param message: the message to scrutinize
-    :return: None
-    """
-    if message.author != client.user:
-        await _react_on_mention(message)
-
-
-@slash.slash(
-    name="get",
-    description="Looks up the answer to a query by its ID.",
-    options=[
-        create_option(
-            name="index",
-            description="Select a question index",
-            option_type=4,
-            required=True
-        )
-    ]
-)
-async def _get(ctx, index: int):
-    """
-    Looks up the answer to a query by its ID.
-
-    :param ctx: the context to send messages to
-    :return: None
-    """
-    embed = discord.Embed(
-        title=f"Pymon v{__version__}: Answer to ID-{index}",
-        color=discord.Color.red(),
-        url=queries[index].get("resource", discord.embeds.EmptyEmbed)
-    )
-    embed.add_field(
-        name=queries[index].get("query"),
-        value=queries[index].get("response"),
-        inline=False
     )
-    similar_queries = queries[index].get("similar_queries", [])[:3]
-    if similar_queries:
-        embed.add_field(
-            name="Similar Queries",
-            value="\n".join(
-                f"• ID-{i}: {utils.create_md_link(queries[i].get('resource'), queries[i].get('query'))}"
-                for i in similar_queries
-            ),
-            inline=True
-        )
-
-    await ctx.send(embed=embed)
-
-
-@slash.slash(
-    name="study",
-    description="Provides a study guide from a set of predetermined tags.",
-    options=[
-        create_option(
-            name="tag",
-            description="Select a topic for your study guide.",
-            required=True,
-            option_type=3,
-            choices=[
-                create_choice(
-                    value=tag,
-                    name=f"{tag} ({len(utils.get_queries_from_tag(queries, tag))})",
-                )
-                for tag in sorted(utils.generate_tags_set(queries))
-            ]
-        )
-    ]
-)
-async def _study(ctx, tag: str):
-    """
-    Prints out a list of questions relevant to the tag.
-
-    :param ctx: the context to send messages to
-    :return: None
-    """
-    matches = utils.get_queries_from_tag(queries, tag)
-    embed = discord.Embed(
-        title=f"Pymon v{__version__}: Study Guide for {tag}",
-        color=discord.Color.red(),
-        description="\n".join(
-            f"• ID-{match[0]}: {utils.create_md_link(match[1].get('resource'), match[1].get('query'))}"
-            for match in matches
-        )
+    console_handler = logging.StreamHandler(sys.stdout)
+
+    # Setup formatter
+    msg_format = f'[Pymon {VERSION}] %(asctime)s,%(msecs)d %(levelname)-8s [%(filename)s:%(lineno)d] %(message)s'
+    date_format = '%Y-%m-%d:%H:%M:%S'
+
+    # Setup root logger
+    logging.basicConfig(
+        handlers=[file_handler, console_handler],
+        level=logging.DEBUG,
+        format=msg_format,
+        datefmt=date_format,
     )
 
-    await ctx.send(embed=embed)
+    # Load key environment variables
+    load_dotenv()
 
-
-@slash.slash(
-    name="refresh",
-    description="Refreshes the bot's knowledge base.",
-)
-async def _refresh(ctx):
-    """
-    Refreshes the bot's knowledge base.
-
-    :param ctx: the context to send messages to
-    :return: None
-    """
-    new_queries, new_keyword_mapping = utils.refresh_knowledge()
-    global queries, keyword_mapping
-    diff = [x for x in new_queries if x not in queries]
-    queries, keyword_mapping = new_queries, new_keyword_mapping
-    await ctx.send(f"{len(diff)} queries modified and/or added.")
-
-
-if __name__ == '__main__':
-    client.run(os.environ.get("DISCORD_TOKEN"))
+    # Initialize and run discord bot
+    client = bot.Pymon()
+    client.run(os.environ.get("DISCORD_TOKEN"), log_handler=None)

.gitignore

@@ -0,0 +1 @@
+VERSION = "1.0.0"