Merge pull request #69 from LewisProjects/development

2.1 XP boost reintroduction and some smaller fixes and more logs

Author: LevaniVashadze

CONTRIBUTING.md

@@ -15,7 +15,7 @@ The following is a set of guidelines for contributing to Ogiroid, which is a par
 > This project and everyone participating in it is governed by the Ogiroid code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the developers.
 
 ## [What do I require before getting started?](#prerequisites)
-We expect you to be experienced with [Python](https://www.python.org/) and [Disnake](https://disnake.dev/) (a fork of [Discord.py](https://github.com/Rapptz/discord.py)). Having experience with Discord.py should also get you sailing, disnake and discord.py are almost the same. 
+We expect you to be experienced with [Python](https://www.python.org/) and [Disnake](https://disnake.dev/) (a fork of [Discord.py](https://github.com/Rapptz/discord.py)). Having experience with Discord.py should also get you sailing, disnake and discord.py are almost the same, or you could also take a look at the very helpful disnake documentation.
 
 ## [What can I do to contribute?](#contribution) 
 **1. Reporting any bugs 🐞:**
@@ -48,3 +48,37 @@ Alternatively, you can headover to our [Discord Server](https://discord.com/5uw4
 With that being said, you have officially reported a bug! Thank you so much 🤩!
 
 <!--Contributing.md: writeup #1-->
+
+### Contributing Code
+
+Fork the repository and then clone it using: (make sure to insert your username)
+
+```git clone https://github.com/YOURGITHUBUSERNAME/Ogiroid.git```
+
+After this get into the folder you cloned the repository to.
+We always work on the development branch so make sure you are on the dev branch.
+
+```git checkout development```
+
+Now you need to create a Discord Bot if you don't already have one. Please look up a guide for how to do this.
+Invite the bot to a test server you own or create a test server.
+
+Now copy secrets.env.template and rename the copy to secrets.env
+Insert your bots token in the correct field.
+Set development to true. The rest can be ignored for now.
+
+To install the requirements:
+
+```pip install -r requirements.txt```
+
+And finally to run the bot:
+
+```python main.py```
+
+utils/CONSTANTS.py stores the ids for various channels, for the main server and for the official development server, to wich you will gain access after a significant contribution. 
+
+Use ```black . --safe``` for formatting (need to install black with pip)
+
+If you need any help contact us on discord or open an issue.
+
+After you have finished writing the code open a PR with the base branch being development.

README.md

@@ -17,6 +17,8 @@ Main Contributors/Developers:
 </ul>
 The bot is currently on release: <b>2.0</b><br>
 License: MIT<br>
+
+<h3>Contributing</h3>
 Wish to Contribute to this bot? Checkout: <a href="https://github.com/LewisProjects/Ogiroid/blob/development/CONTRIBUTING.md">contribution guidelines</a>
 <hr>
 

cogs/AI.py

@@ -1,8 +1,10 @@
 import base64
-from io import BytesIO
 import time
+from io import BytesIO
+
 import disnake
 from disnake.ext import commands
+
 from utils.bot import OGIROID
 
 
@@ -13,11 +15,19 @@ def __init__(self, bot: OGIROID):
     @commands.slash_command(description="Generates ai art")
     async def ai_art(self, inter: disnake.ApplicationCommandInteraction, text):
         ETA = int(time.time() + 60)
-        await inter.send(f"Go grab a coffee this may take a while... ETA: <t:{ETA}:R>", ephemeral=True)
-        response = await self.bot.session.post("https://backend.craiyon.com/generate", json={"prompt": text})
+        await inter.send(
+            f"Go grab a coffee this may take a while... ETA: <t:{ETA}:R>",
+            ephemeral=True,
+        )
+        response = await self.bot.session.post(
+            "https://backend.craiyon.com/generate", json={"prompt": text}
+        )
         r = await response.json()
         raw_images = r["images"]
-        images = [disnake.File(BytesIO(base64.decodebytes(i.encode("utf-8"))), "image.png") for i in raw_images]
+        images = [
+            disnake.File(BytesIO(base64.decodebytes(i.encode("utf-8"))), "image.png")
+            for i in raw_images
+        ]
 
         await inter.edit_original_response(files=images, content="Here you go!")
 

cogs/Animals.py

@@ -26,7 +26,10 @@ async def cat(self, inter):
             color=0xFFFFFF,
         )
         embed.set_image(url=data["image"])
-        embed.set_footer(text=f"Command issued by: {inter.author.name}", icon_url=inter.author.display_avatar)
+        embed.set_footer(
+            text=f"Command issued by: {inter.author.name}",
+            icon_url=inter.author.display_avatar,
+        )
         await inter.response.send_message(f"**Fun Fact: **" + data["fact"], embed=embed)
 
     @animal.sub_command(name="dog", description="Get a random dog picture")
@@ -40,7 +43,10 @@ async def dog(self, inter):
             color=0xFFFFFF,
         )
         embed.set_image(url=data["image"])
-        embed.set_footer(text=f"Command issued by: {inter.author.name}", icon_url=inter.author.display_avatar)
+        embed.set_footer(
+            text=f"Command issued by: {inter.author.name}",
+            icon_url=inter.author.display_avatar,
+        )
         await inter.response.send_message("**Fun Fact: **" + data["fact"], embed=embed)
 
     @animal.sub_command(name="bird", description="Get a random bird picture")
@@ -54,7 +60,10 @@ async def bird(self, inter):
             color=0xFFFFFF,
         )
         embed.set_image(url=data["image"])
-        embed.set_footer(text=f"Command issued by: {inter.author.name}", icon_url=inter.author.display_avatar)
+        embed.set_footer(
+            text=f"Command issued by: {inter.author.name}",
+            icon_url=inter.author.display_avatar,
+        )
         await inter.response.send_message("**Fun Fact: **" + data["fact"], embed=embed)
 
     @animal.sub_command(name="fox", description="Get a random fox picture")
@@ -68,7 +77,10 @@ async def fox(self, inter):
             color=0xFFFFFF,
         )
         embed.set_image(url=data["image"])
-        embed.set_footer(text=f"Command issued by: {inter.author.name}", icon_url=inter.author.display_avatar)
+        embed.set_footer(
+            text=f"Command issued by: {inter.author.name}",
+            icon_url=inter.author.display_avatar,
+        )
         await inter.response.send_message("**Fun Fact: **" + data["fact"], embed=embed)
 
     @animal.sub_command(name="panda", description="Get a random panda picture")
@@ -82,7 +94,10 @@ async def panda(self, inter):
             color=0xFFFFFF,
         )
         embed.set_image(url=data["image"])
-        embed.set_footer(text=f"Command issued by: {inter.author.name}", icon_url=inter.author.display_avatar)
+        embed.set_footer(
+            text=f"Command issued by: {inter.author.name}",
+            icon_url=inter.author.display_avatar,
+        )
         await inter.response.send_message("**Fun Fact: **" + data["fact"], embed=embed)
 
     @animal.sub_command(name="koala", description="Get a random cat picture")
@@ -96,7 +111,10 @@ async def koala(self, inter):
             color=0xFFFFFF,
         )
         embed.set_image(url=data["image"])
-        embed.set_footer(text=f"Command issued by: {inter.author.name}", icon_url=inter.author.display_avatar)
+        embed.set_footer(
+            text=f"Command issued by: {inter.author.name}",
+            icon_url=inter.author.display_avatar,
+        )
         await inter.response.send_message("**Fun Fact: **" + data["fact"], embed=embed)
 
 

cogs/Birthdays.py

@@ -1,15 +1,15 @@
 import datetime
+import datetime as dt
+import random
 
 import disnake
-import datetime as dt
 from disnake.ext import commands, tasks
-import random
 
+from utils.CONSTANTS import months, congrats_messages
 from utils.DBhandlers import BirthdayHandler
+from utils.bot import OGIROID
 from utils.exceptions import UserAlreadyExists, UserNotFound
 from utils.shortcuts import QuickEmb, sucEmb, errorEmb
-from utils.CONSTANTS import months, congrats_messages
-from utils.bot import OGIROID
 
 
 class Birthday(commands.Cog):
@@ -30,11 +30,18 @@ def cog_unload(self):
     async def birthday(self, inter: disnake.ApplicationCommandInteraction):
         pass
 
-    @birthday.sub_command(name="set", description="Set your birthday. Cant be removed without Staff.")
+    @birthday.sub_command(
+        name="set", description="Set your birthday. Cant be removed without Staff."
+    )
     async def set(
         self,
         inter,
-        day: int = commands.Param(name="day", ge=1, le=31, description="The day of your birthday. Select carefully."),
+        day: int = commands.Param(
+            name="day",
+            ge=1,
+            le=31,
+            description="The day of your birthday. Select carefully.",
+        ),
         month: str = commands.Param(
             name="month",
             description="The month of your birthday. Select carefully.",
@@ -55,17 +62,23 @@ async def set(
         await sucEmb(inter, f"Your birthday has been set to {birth_date}")
 
     @commands.has_permissions(manage_roles=True)
-    @birthday.sub_command(name="edit", description="Edit a users birthday. Can only be done by Staff.")
+    @birthday.sub_command(
+        name="edit", description="Edit a users birthday. Can only be done by Staff."
+    )
     async def edit(
         self,
         inter,
-        day: int = commands.Param(name="day", ge=1, le=31, description="The day of the birthday."),
+        day: int = commands.Param(
+            name="day", ge=1, le=31, description="The day of the birthday."
+        ),
         month: str = commands.Param(
             name="month",
             description="The month of the birthday.",
             choices=months,
         ),
-        user: disnake.User = commands.Param(name="user", description="User to edit the birthday of."),
+        user: disnake.User = commands.Param(
+            name="user", description="User to edit the birthday of."
+        ),
     ):
         try:
             await self.birthday.update_user(user.id, f"{day}/{month}")
@@ -74,11 +87,15 @@ async def edit(
             return await errorEmb(inter, "The User doesn't have a birthday set")
 
     @commands.has_permissions(manage_roles=True)
-    @birthday.sub_command(name="remove", description="Remove a birthday. Can only be done by Staff.")
+    @birthday.sub_command(
+        name="remove", description="Remove a birthday. Can only be done by Staff."
+    )
     async def remove(
         self,
         inter: disnake.ApplicationCommandInteraction,
-        user: disnake.User = commands.Param(name="user", description="Removes the birthday of this user"),
+        user: disnake.User = commands.Param(
+            name="user", description="Removes the birthday of this user"
+        ),
     ):
         try:
             await self.birthday.delete_user(user.id)
@@ -88,7 +105,9 @@ async def remove(
         await sucEmb(inter, "The birthday has been removed")
 
     @birthday.sub_command(name="get", description="Get the birthday of a user")
-    async def get(self, inter, user: disnake.User = commands.Param(name="user", default=None)):
+    async def get(
+        self, inter, user: disnake.User = commands.Param(name="user", default=None)
+    ):
         if user is None:
             user = inter.author
         else:
@@ -98,9 +117,13 @@ async def get(self, inter, user: disnake.User = commands.Param(name="user", defa
         if birthday is None:
             return await errorEmb(inter, "This user doesn't have a birthday set")
 
-        next_birthday = datetime.datetime.strptime(birthday.birthday + f"/{dt.datetime.now().year}", "%d/%m/%Y")
+        next_birthday = datetime.datetime.strptime(
+            birthday.birthday + f"/{dt.datetime.now().year}", "%d/%m/%Y"
+        )
         if next_birthday < datetime.datetime.now():
-            next_birthday = datetime.datetime.strptime(birthday.birthday + f"/{dt.datetime.now().year + 1}", "%d/%m/%Y")
+            next_birthday = datetime.datetime.strptime(
+                birthday.birthday + f"/{dt.datetime.now().year + 1}", "%d/%m/%Y"
+            )
         await QuickEmb(
             inter,
             f"{user.mention}'s birthday is in {(next_birthday - datetime.datetime.now()).days} Days."
@@ -128,11 +151,18 @@ async def birthday_check(self):
             # if the birthday is today, congratulate the user
             if user.birthday == today:
                 await member.add_roles(guild.get_role(self.bot.config.roles.birthday))
-                congrats_msg = await channel.send(f"{random.choice(congrats_messages)} {member.mention}! 🎂")
+                congrats_msg = await channel.send(
+                    f"{random.choice(congrats_messages)} {member.mention}! 🎂"
+                )
                 await congrats_msg.add_reaction("🥳")
             # If the birthday isn't today and the user still has the birthday role, remove it
-            elif user.birthday != today and member.get_role(self.bot.config.roles.birthday) is not None:
-                await member.remove_roles(guild.get_role(self.bot.config.roles.birthday))
+            elif (
+                user.birthday != today
+                and member.get_role(self.bot.config.roles.birthday) is not None
+            ):
+                await member.remove_roles(
+                    guild.get_role(self.bot.config.roles.birthday)
+                )
 
 
 def setup(bot):