mrhedmad / milton Goto Github PK

The core/cogs folder adds a lot of visual confusion on where to put actual core cogs that must be loaded and those that can be disabled.

The folder should be removed, and the "core" cogs moved in just "core".

Please do not pollute my $HOME with junk. Thanks!

The error handler should be more composable. By this I mean using decorators with functions to handle single errors.

It is probably best to move from a cog to a module in the bot's core, and make the loading of the handler mandatory, with listeners in the bot instance itself.

As cogs can handle their own cog-specific errors, adding and removing handlers in the error handler at run time is not necessary.

Currently, the annoucements cog uses google to send emails. Gmail is not meant to be used to send emails from automated accounts.

The cog should be modified to use a commercial email provider like SendGrid or similar, which provide actual robust APIs to send automatic announcement emails.

On the other hand, the cog could be simply replaced by a mailing-list manager cog, that records who want to be emailed and provides the correct email list that a human can then use to send announcements.

One often needs to retrieve or inspect a remote repository file. We should add a cog that, for public repositories (private repos need token access, but we cannot store it not in plain text for now, so let's not do that), fuzzy-finds the files and:

• If no files match, say so and provide a link to the repo;
• If one file matches, provide a link and the content (cropped if need be) of the file;
• If multiple file match, provide a list of them with relevant links;

Additionally, it would be nice to implement:

• An optional grep pattern to match the file with;

Tracking

• Core implementation
• Grep support

A reagent catalogue is a collection of all the names of the reagents, their location and their quantity that is present in a lab.

A cog that can create, manage and help in browsing such a catalogue would be useful.

Allowing multiple owners should be allowed, as d.py does allow multiple bot owners.

This change should be reflected in the configuration as well as in any custom checks done in milton.utils.checks.

I want Milton to target research organizations, so we have to do some rebranding:

• Change Milton's name to "Milton Lab Assistant";
• Rebrand Milton's logo to something more... pretty?

A long time ago I submitted a PR to d.py with a change to the tasks module that allowed tasks to run at specific times each day. The PR was rejected, but a (better) version of it has since been included in the discord.ext.tasks module.

Therefore, the utils.tasks file (with my PR) has since been superseded by the d.py implementation.

We should migrate from the local tasks file to the d.py one.

Some minor tasks are listed here, which may not require a commit per-se, but they should be addressed nonetheless:

• The paginator might be weird with the new slash command specification;
• Add utilites to access the pkg_resources in an easier way (and as Paths instead of whatever the package.resources module gives out).

Deploying an instance is easy, but sometimes - due to Python versioning and some other external requirements that apparently not everyone has (cough poppler cough) - it can be a pain.

Write a Dockerfile to generate a Docker image, so that deployment is easier.

TODO

• Write a dockerfile;
• Add an auto-deploy-to-dockerhub action on release;
• Write an utility script that pulls the image if needed, mounts the volumes as needed and runs the bot instance;
• Add to the README this possibility (with those cool and super unsafe 'Run wget ... | sh and get started in seconds!' bits)

There might be some dependencies that the bot does not use, or can avoid using (by implementing the functionality in the bot itself).

The documentation needs a bit of love:

• Write a better README, and add the all-contributors bot.
• Write an actual CONTRIBUTING.md guide.
• Write a tiny bit of documentation on how to configure the bot.

Perhaps the docs should be moved to their own /docs/ dir, for better future support.

The CLI module (cli.py) should be overhauled.

• There is no support to use ARROW UP and ARROW DOWN to cycle through the CLI history.
• There is not TAB completion support.
• There could be command composition support (such as that provided by discord.py)

A possible solution would be to use an appropriate library such as click or similar, but they would need to be capable of async.

It is best to move the CLI out of the cogs and into the bot itself, and schedule its execution with asyncio.Loop.create_task as the bot starts (run) and stop it as the bot closes (close).

The slash command stuff by Discord is nice, but since this bot is designed to not be deployed in a very large number of servers, the privileged MessageContent intent can still be requested. For some commands, like:

• Github browsing (See issue #17);
• The "snippet" feature (See issue ?);
• Some admin-only commands in the various cogs (like the 'sudo' announcement commands and the birthday admin commands);

it makes sense to make them text-only (or dual text-slash).

We should begin following the gitmoji specification.

Also, add the tag to the README

The YAML parsing is way too powerful for the very, very simple things that we need to do.

TOML is very easy to parse, supports comments, and is very easy to write. Since we need to do something simple, let's use something simple to do it.

Some cogs have run their course: They were implemented at the very start of development mostly to test features out. Since they just add useless commands, they should be removed:

• The roll command in the toys cog;
• The ping command in the meta cog;