harris-ferguson / duedatebot

A discord bot that can track due dates and send reminders.

duedatebot

a due date reminder bot for discord Create new Due-Dates, sort them by Course, and add what files you need to hand in!

Installing

Link to add to your server!

Contributing:

Dependancies:

You will need to install the following packages via pip:

• discord
• pymongo
• dotenv

Setting up the Environment

After making sure you have the proper python packages, clone the repo. In the same directory as the codebase, create a file called .env, with the following content:

# .env
DISCORD_TOKEN=<Your discord bot token>
DB_PASS=<Your mongodb token>

For developing, you should create your own discord bot and test server to run it in. create your own cluster with MongoDB as well for testing.

What to do?

• Writing Documentation (ESPECIALLY doctstrings)
• Screenshots of commands in action (so we can put them on this page!)
• Writing better help messages
• Writing more interesting reply messaages
• Coming up with ideas for commands
• Adding command Aliases

Check out Issues for stuff you can help out with!

duedatebot's Issues

Non-case matching searches

We should check through the database without checking for case-matching when looking for documents.

Store Posts in Chronological Order

We should store posts in chronological order, and possibly implement a sorter. This will help us do things like

• List posts in chronological order
• Get the next item due

New Command: Days Till Due

Command will print the days until a specified assignment is due. It would be nice if we could invoke this with the name and title of the assignment but we might have to resort to using the assignment id.

Testing

We need a testing suite! pytest would be easy enough to get rolling. With my limited time and this projects small userbase (the use of this app is primarily 1 small school discord server), my priority is in building out features we need, but setting up testing is gunna be invaluable.

Change Date references to use the Discord API

the discord api allows us to get the date that the local server has, so we should change our method of getting the current day to use this to avoid bugs in several time related functions.

Due Date Time is storing Minutes and Seconds

When printing an assingment using the @show command, the Due Today At message will display an incorrect due time. This is because due times are mixing up the second and minute fields.

Modularize the bot

We should take the time to modularize the bot into some Classes using the Cog framework that discord.py provides.

Let reminders have a time to remind option

Currently reminders just trigger at a certain number of seconds after the user invoked the command, meaning entering 2 days at 11 will mean you get reminded 2 days later at 11. We should let the command invocation include a "time to remind at" field.

Discord Slash Command Preview

Discords new update has a new Slash Command feature. We should support this feature so people can have an easier time navigating our commands. We need to register these slash commands with an HTTP request, see the above link.

Deal with Collisions when creating the Assignment ID

We should have a simple way of checking if we have a collision in the AssignmentID hash.

Automate removal of past due assignments

Since we have an event loop running for reminders, we could use the same event loop to check for anything in the assignments database that is past due. We could tie it to a boolean that the user can optionally set, just in case there is a desire to keep assignments for some time after they are due.

build_output_string can't handle empty fields

duedatebot/helpers.py

Line 3 in 954f62e

def build_output_string(post):

this function will break if the field "handins" is empty. Although the function which creates new documents doesn't allow for this field to be empty, this function should be more robust to handle this.

New Command: Clear Hand-in Items

We need a command to clear all the handins from a given document. It's important that is command ensures the handins field is not left empty, as referenced in this issue

New Command: Change Due Date

We need a command to change the due date of a given item.

Add Docstrings to Methods

None of the methods have docstrings, we should add them! Simple as that.

New Command: Get Assignment

Get an assignment by its ID and print it out to the guild. This is also needed for some other setter/getter functions so we can immediately display any changes made.

New Command: Due This Week

We need a command that checks for everything due in a given week. Dates are stored as datetimes from the Python datetime module, so we can use the features of that to check if something is happening within the current week.

Date adding should include time

duedatebot/bot.py

Line 32 in ae17156

duedatetime = datetime.strptime(arg3, '%b%d%Y')

We should allow the user to include a time, while avoiding errors if they try to create an assignment without a due-time.

If hand ins list has only "None!", addhandin needs to remove this element

Either we need to check for the first element being "None!" or we should come up with a new way to deal with the hand ins list to be empty (see) Either way we just need to be consistent about it.

Timed Reminders

Timed Reminders

Daily, Weekly, or Monthly Reminders of important upcoming dates!

Features

Set a reminder to go off at a specific daily time
Set a reminder to go off once every set amount of days
Ping users for important upcoming dates if they have a role matching the class title
Ping @here in a channel matching the course ID

Abstract Date Parsing behaviour

We should abstract the behaviour of parsing a datetime to a helper method. Said method should be set up to use Regex and match multiple different formats of datetime to allow for easier usage.

Allow reminders to have a list of specific assignments to remind

We should allow the user to upload a list of Assignment IDs for which they want to be reminded of. If nothing is provided then we give them a reminder for everything in the guild.

Ensure proper types are stored in the database

We need to check that the proper types are stored in the database. Most of what we store are just strings, however we particularly want to ensure that we are storing python datetime objects instead of a string. Assignment IDs should also be integers instead of strings.

Bulk Add From CSV

Bulk Add

Bulk Add an entire schedule from a csv file.

Details

Ensure everything adding conforms with the type we store in the db. We could either invoke the existing adddate command to add everything or make use of pymongos insert_many command to do it all at once.

New Command: Delete Item

We need a command that deletes an item. We should also write a function we can call that deletes anything that is past due.

Let the user enter more time options for reminders

currently reminders only accept Days and Second (for testing), however we should also allow the user to enter Weeks and Months (and maybe years but im not sure who would use that).

This would involve expanding the following section of code:

duedatebot/duedates.py

Lines 204 to 208 in afb3270

	if "Days" in arg2 or "days" in arg2 or "day" in arg2 or "Day" in arg2:
	quantity_multiplier = 86400
	#seconds is here for testing
	if "Seconds" in arg2 or "seconds" in arg2:
	quantity_multiplier = 1

to include more quantity multipliers. The quantity multiplier should convert a number of given units of time to seconds, so that the event loop function which checks all the reminders against the Epoch can check if the given date is in the past.