Team 23

README.md

@@ -1,4 +1,6 @@
-# Code Jam 1
+# Code Jam 1 - Team 23
+
+**This is the code jam entry for Momo & kel**
 
 This is the repository for all code relating to our first code jam, in March 2018. Participants should fork this repository, and submit their code in a pull request.
 

bot/cogs/snakes.py

@@ -1,11 +1,29 @@
 # coding=utf-8
 import logging
-from typing import Any, Dict
 
+import discord
 from discord.ext.commands import AutoShardedBot, Context, command
 
+from bot.sneks.sneks import SnakeDef
+
 log = logging.getLogger(__name__)
 
+# the python snek
+SNEK_PYTHON = SnakeDef(
+    common_name="Python",
+    species="Pseudo lingua",
+    image_url="https://momoperes.ca/files/pythonpls.png",
+    family="sneks-that-byte",
+    genus="\"Programming Language\"",
+    short_description="python is a language that you learn because tensorflow has an API for it",
+    wiki_link="https://en.wikipedia.org/wiki/Pseudocode"
+)
+
+# consolation snek :(
+SNEK_SAD = discord.Embed()
+SNEK_SAD.title = "sad snek :("
+SNEK_SAD.set_image(url="https://momoperes.ca/files/sadsnek.jpeg")
+
 
 class Snakes:
     """
@@ -15,33 +33,24 @@ class Snakes:
     def __init__(self, bot: AutoShardedBot):
         self.bot = bot
 
-    async def get_snek(self, name: str = None) -> Dict[str, Any]:
-        """
-        Go online and fetch information about a snake
-
-        The information includes the name of the snake, a picture of the snake, and various other pieces of info.
-        What information you get for the snake is up to you. Be creative!
+    async def get_snek(self, name: str = None) -> SnakeDef:
+        if name is not None and name.lower() == "python":
+            # return info about language
+            return SNEK_PYTHON
 
-        If "python" is given as the snake name, you should return information about the programming language, but with
-        all the information you'd provide for a real snake. Try to have some fun with this!
-
-        :param name: Optional, the name of the snake to get information for - omit for a random snake
-        :return: A dict containing information on a snake
-        """
+        # todo: find a random snek online if there name is null
+        # todo: scrape the web to find the lost sneks
 
     @command()
     async def get(self, ctx: Context, name: str = None):
-        """
-        Go online and fetch information about a snake
-
-        This should make use of your `get_snek` method, using it to get information about a snake. This information
-        should be sent back to Discord in an embed.
-
-        :param ctx: Context object passed from discord.py
-        :param name: Optional, the name of the snake to get information for - omit for a random snake
-        """
-
-    # Any additional commands can be placed here. Be creative, but keep it to a reasonable amount!
+        # fetch data for a snek
+        await ctx.send("Fetching data for " + name + "..." if name is not None else "Finding a random snek!")
+        data = await self.get_snek(name)
+        if data is None:
+            await ctx.send("sssorry I can't find that snek :(", embed=SNEK_SAD)
+            return
+        channel: discord.TextChannel = ctx.channel
+        await channel.send(embed=data.as_embed())
 
 
 def setup(bot):

bot/sneks/__init__.py

@@ -0,0 +1 @@
+# coding=utf-8

bot/sneks/sneks.py

@@ -0,0 +1,29 @@
+import discord
+
+
+class SnakeDef:
+    """
+    Represents a snek
+    """
+
+    def __init__(self, common_name, species, image_url, family, genus, short_description, wiki_link):
+        self.common_name = common_name
+        self.species = species
+        self.image_url = image_url
+        self.family = family
+        self.genus = genus
+        self.short_description = short_description
+        self.wiki_link = wiki_link
+
+    def as_embed(self):
+        # returns a discord embed with the snek
+        embed = discord.Embed()
+        embed.title = self.species + " (" + self.common_name + ")"
+        embed.colour = discord.Colour.green()
+        embed.url = self.wiki_link
+        embed.add_field(name="Family", value=self.family)
+        embed.add_field(name="Genus", value=self.genus)
+        embed.add_field(name="Species", value=self.species)
+        embed.set_image(url=self.image_url)
+        embed.description = self.short_description
+        return embed

run.py

@@ -16,7 +16,7 @@
         ">>> ", ">> ", "> ",
         ">>>", ">>", ">"
     ),  # Order matters (and so do commas)
-    activity=Game(name="Help: bot.help()"),
+    activity=Game(name="snek it up"),
     help_attrs={"aliases": ["help()"]},
     formatter=Formatter()
 )