beatrice-witchcogs application

[PookaMustard]

List: beta Repository name: beatrice-witchcogs Author: PookaMustard Description: General-purpose cogs made for Red-DiscordBot, mostly search cogs.

Additional notes: The Bing cog uses code from Mash's IMDb cog, namely the JSON code. The same will be of the MyAnimeList cog later on, as it will take the same makeover. Mash has allowed this.

[Eslyium]

1. Please Fix Your Info.jsons http://twentysix26.github.io/Red-Docs/red_cog_info_json/
2. Not have features that are already in Red (nineball) Im not to sure on this one.. Ill leave this up to Twenty.
3. People who worked on a cog must be properly credited If most of the JSON work was done by someone else id at least put them in the Info.json, Unless they said it was fine.

Other than that. Nice cogs.

[PookaMustard]

1. Not sure what needs to be fixed about the info.jsons because I copied the formatting from other cogs. That said, I will copy the format from here.
2. I can remove the nineball cog no problem.
3. Noted that, will credit Mash in the Bing info.json.

Will get to work on fixing these soon.

[PookaMustard]

Took the following actions:

1. Updated cog info.jsons to reflect the standard used by Red-Docs, also added a repo info.json
2. Removed nineball cog
3. Properly credited Mash (his name, his origin cog, and his permission) in the Bing info.json in the Description section.

[Redjumpman]

Your readme should have a contact section that provides info on how to contact you for issues with any of your cogs. Preferably a way to DM you in discord or the Red server to possibly filter help requests out of #support channel.

[PookaMustard]

That's complete as well. Readme now suggests either leaving an issue on my repo or sending me a message on Discord.

[Twentysix26]

You're not specifying 3rd party libs requirements in your info.json files. There are no checks at load to let the user know they're missing them either.

https://github.com/PookaMustard/beatrice-witchcogs/blob/0f486bfc51cfc383899348b84d3936a9b6f2196e/commandrequest/commandrequest.py#L77 This is a huge security hole that lets everyone run arbitrary code. You also expect the user to edit the code to configure it. Huge no no.

Classes names should be CamelCase. This is the norm and what the user expects when trying to do [p]help CogName.

That was just a quick look, it's overall very messy, lots of useless imports / code that derives from copy pasting and some commands of dubious utility.

I also suggest to take a good read on how to use git properly, from the commits you seem to be using github as an online text editor.

[PookaMustard]

All your points taken for granted, but I'm comfortable with the way I use github and as such, I will continue to use it as an online text editor. The functionality is provided for me and I see no reason why to deviate from my current setup.

[PookaMustard]

Remade Echo and Command Request. For both, simpler (bot-provided) code is used rather than arbitrary code, and for the latter, it now uses a homegrown basic JSON file system for saving the channel ID as opposed to editing the cog itself. Other code updates might be on the way.

Also, using the CamelCase class naming.

By the way, what are those "commands of dubious utility"?

[Twentysix26]

What's the purpose of this command? https://github.com/PookaMustard/beatrice-witchcogs/blob/ae30e2b1adc5017902f214f44403103b3c3458bc/commandrequest/commandrequest.py#L13

[PookaMustard]

For bots with owners that accept various custom command suggestions from a large community, [p]commandrequest comes in handy. What it does is send these suggestions from separate channels to just one. For example, there are four servers, A, B, C and X. Rather than searching for command suggestions in servers A, B, and C (including its channels), all the suggestions get sent to X, and in one channel.

That is its purpose, and I will make it clearer in the info.json. Speaking of coding, I just improved the overall coding of the Bing cog.

[Redjumpman]

For your cogs that require 3rd party libraries, you need to specify to the user that it's required, and give them an error if it's not loaded. An example may look like this:

In your imports

try:   # check if BeautifulSoup4 is installed
    from bs4 import BeautifulSoup
    soupAvailable = True
except:
    soupAvailable = False

In your setup

def setup(bot):
    if soupAvailable:
        n = Cogname(bot)
        bot.add_cog(n)
    else:
        raise RuntimeError("You need to run 'pip3 install beautifulsoup4'")

As 26 Mentioned, you should also specify in your info.JSON file any required 3rd party libraries. But the above helps catch those that don't read and points them in the right direction.

[PookaMustard]

Good catch, I like this other way to do it. Will set it up immediately.

[Redjumpman]

Here is small list of stuff I caught on some of your cogs. Please don't take this the wrong way, just trying to up the quality and help out with your request.

Appsearcher

• Capitalize your class name. Should be Appsearcher, instead of appsearcher

Remove the following from your import list:

• discord
• re
• randchoice (the whole thing)

Unused variables:

• windows_checked = 0
• linux_checked = 0
• mac_checked = 0
• All of your comments should have a space after the #
• When checking for a boolean, you shouldn't be using == True/False should be is or is not. In most cases you can just say If thing: which checks if it's true
• There are a lot of mixed tabs and spaces within the code
• There are some operators that do not have proper spacing. Example: query=text.replace(" ", "+")
• Whitespace

Bing

• Remove import discord. Why do you keep importing this :(
• Same thing with conditions here. use is and is not instead of == for bools
• Tons and tons of indentations containing a mix of tabs and spaces

Command Request

• Remove import discord. Please.
• Too many # for block comments.
• whitespace
• Some indentation errors

Echo

• Remove import discord
• Things could be stylistically better, but the above should be fine.

Isitdown

• Remove import discord.
• When you add in a keyword argument, you shouldn't put a space between the operator. headers={}

animelist

• Remove import discord
• Comments need to have a space after #
• Missing some whitespace around operators

Pokemon

• Remove import discord
• Remove import randint
• Missing whitespace around a lot of operators
• Missing space after # in comments

ThePirateBay

• Remove import discord
• Missing whitespace around operators
• Missing space after # in comments

Don't see this as an attack. I'm here to help.

[PookaMustard]

Thanks for the list, Redjumpman! This should be a good enough serving point to know which problems I really need to tackle when handling Python and Red.

The thing about import discord is because it was in the original documentation for how to build a cog. As for appsearcher which is the biggest list, that has to wait as it may go through a makeover, similar to Bing. And those indentations are killing the hell out of me (the mixing that is), so I will also see it.

I'll have to take a break from doing these fixes for a short while. I should resolve some of them if not all by tomorrow.

[Chovin]

I recommend hanging out in #coding and #testing to learn more about the current best practices when writing cogs. This will also help make sure your cogs don't interfere with other cogs in the bot and that you don't have any security issues.

The how to build a cog guide is not necessarily the best and it won't teach you everything. Keep at it 👍

[PookaMustard]

I just knew of autopep8 and flake8, which will make sorting the code even easier. I pushed a commit to Bing which sorts all the listed issues. Will look after the rest.

[PookaMustard]

Did the same as above for some of the remaining cogs. Also added a dictionary cog which uses the PyDictionary module, which put what I learned into perspective in a new utility.

[Eslyium]

Closed, Sorry for the long delay,

Finally had time to come back and look at all of these.

Feel free if you become active again to retry.