Merge pull request #491 from tweirtx/master

Fix slash command timeouts with modlog, update documentation, and fix lint

Author: tweirtx

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.10.6
+FROM python:3.10.19
 WORKDIR /app
 COPY . /app
 RUN pip install -Ur requirements.txt

docs/Actionlog.rst

@@ -15,16 +15,6 @@ Command group to configure Join/Leave logs
 `{prefix}memberlogconfig setjoinmessage template`: Sets join template
 `{prefix}memberlogconfig setleavemessage template`: Sets leave template
 `{prefix}memberlogconfig help`: Returns the template formatting key
-setleavemessage
-+++++++++++++++
-Configure custom leave message template
-::
-   
-setjoinmessage
-++++++++++++++
-Configure custom join message template
-::
-   
 help
 ++++
 Displays message formatting key
@@ -35,6 +25,22 @@ toggleping
 Toggles whenever a new member gets pinged on join
 ::
    
+setleavemessage
++++++++++++++++
+Configure custom leave message template
+::
+   
+viewconfig
+++++++++++
+Command to view Join/Leave logs configuration.
+::
+   
+togglesendonverify
+++++++++++++++++++
+Toggles if a join log is sent on user joining or on completing
+verification
+::
+   
 disable
 +++++++
 Disables Join/Leave logging
@@ -45,6 +51,11 @@ setchannel
 Configure join/leave channel
 ::
    
+setjoinmessage
+++++++++++++++
+Configure custom join message template
+::
+   
 locknickname
 ++++++++++++
 Locks a members nickname to a particular string, in essence revoking

docs/FTCInfo.rst

@@ -0,0 +1,37 @@
+=======
+FTCInfo
+=======
+ftc
++++
+Get information on an FTC team from FTC-Events. If no subcommand is
+specified, the `team` subcommand is inferred, and the argument is taken
+as a team number.
+::
+   `{prefix}ftc 5667` - show information on team 5667, Robominers
+opr
++++
+Get information with OPR on an FTC team by number.
+::
+   
+searchteam
+++++++++++
+Search for an FTC team by name.
+::
+   `{prefix}ftc search warbots` - show first 5 teams with "warbots" in their name
+matches
++++++++
+Get a match schedule, defaulting to the latest listed event on
+FTC-Events
+::
+   `{prefix}ftc matches 16377` - show matches for the latest event by team 16377, Spicy Ketchup
+`{prefix}ftc matches 8393 USPACMP` - show matches for the Pennsylvania championship by team 8393, BrainSTEM
+team
+++++
+Get information on an FTC team by number.
+::
+   `{prefix}ftc team 7244` - show information on team 7244, Out of the Box Robotics
+topr
+++++
+Get information with OPR on an FTC team by number.
+::
+   

docs/Filter.rst

@@ -17,6 +17,22 @@ Edit an already existing filter using a new pattern. A filter's friendly
 name cannot be edited.
 ::
    `{prefix}filter edit 4 Swear` - Change filter 4 to filter out "Swear" instead of its previous pattern
+add
++++
+Add a pattern to the filter using RegEx. Any word can be added and is
+tested case-insensitive.
+::
+   `{prefix}filter add Swear` - Makes it so that "Swear" will be filtered
+list
+++++
+Lists word filters.
+::
+   
+remove
+++++++
+Remove a pattern from the filter list.
+::
+   `{prefix}filter remove 7` - Disables filter with ID 7
 whitelist
 +++++++++
 List all whitelisted roles for this server
@@ -32,19 +48,13 @@ remove
 Remove a role from the whitelist
 ::
    `{prefix}filter whitelist remove Admins` - Makes it so that Admins are caught by the filter again.
-remove
-++++++
-Remove a pattern from the filter list.
+viewlist
+++++++++
+List all whitelisted roles for this server
 ::
-   `{prefix}filter remove 7` - Disables filter with ID 7
+   
 dm
 ++
 Set whether filter words should be DMed when used in bot messages
 ::
-   `{prefix}filter dm_config True` - Makes all messages containining filter lists to be sent through DMs
-add
-+++
-Add a pattern to the filter using RegEx. Any word can be added and is
-tested case-insensitive.
-::
-   `{prefix}filter add Swear` - Makes it so that "Swear" will be filtered
+   `{prefix}filter dm_config True` - Makes all messages containining filter lists to be sent through DMs 

docs/Info.rst

@@ -7,10 +7,9 @@ Retrieve information about a member of the guild. If no arguments are
 passed, information about the author is used. **This command works
 without mentions.** Remove the '@' before your mention so you don't ping
 the person unnecessarily. You can pick a member by: - Username
-(`cooldude`) - Username and discriminator (`cooldude#1234`) - ID
-(`326749693969301506`) - Nickname - must be exact and is case-sensitive
-(`"Mr. Cool Dude III | Team 1234"`) - Mention (not recommended) (`@Mr
-Cool Dude III | Team 1234`)
+(`cooldude`) - ID (`326749693969301506`) - Nickname - must be exact and
+is case-sensitive (`"Mr. Cool Dude III | Team 1234"`) - Mention (not
+recommended) (`@Mr Cool Dude III | Team 1234`)
 ::
    `{prefix}member`: show your member info
 `{prefix}member {ctx.me}`: show my member info
@@ -24,8 +23,13 @@ rolemembers
 Retrieve members who have this role
 ::
    
-guild
-+++++
+server
+++++++
 Retrieve information about this guild.
 ::
    `{prefix}guild` - get information about this guild
+stats
++++++
+Get current running internal/host stats for the bot
+::
+   `{prefix}stats` - get current bot/host stats

docs/Levels.rst

@@ -3,7 +3,7 @@ Levels
 ======
 meesyncs
 ++++++++
-Function to scrape ranking data from the mee6 api and save it to the
+Function to scrap ranking data from the mee6 api and save it to the
 database
 ::
    `{prefix}meesyncs`: Sync ranking data from the mee6 API to dozer's database
@@ -25,6 +25,11 @@ Swaps Snowplow's xp with Dozer's xp
    `{prefix}adjustlevels transferxp <@Snowplow or "Snowplow"> <@Dozer or "Dozer">`:
 Adds Snowplow's xp to dozer's xp
 
+setlevel
+++++++++
+Changes a members level to requested level
+::
+   
 transferxp
 ++++++++++
 Adds xp from one member to another member
@@ -35,11 +40,6 @@ swapxp
 Swap xp stats between two members in a guild
 ::
    
-setlevel
-++++++++
-Changes a members level to requested level
-::
-   
 adjustxp
 ++++++++
 Adjusts a members xp by a certain amount
@@ -58,44 +58,49 @@ Configures dozer ranks:tm:
 `{prefix}configureranks notificationsoff`: Turns off notification channel
 `{prefix}configureranks setrolelevel role level`: Adds a level role
 `{prefix}configureranks delrolelevel role`: Deletes a level role 
+notificationchannel
++++++++++++++++++++
+Set up the channel where level up messages are sent
+::
+   
+xprange
++++++++
+Set the range of a servers levels random xp
+::
+   
+setrolelevel
+++++++++++++
+Sets a role to be given to a user when they reach a certain level
+::
+   `{prefix}setrolelevel "level 2" 2`: Will configure the role "level 2" to be given to users who reach level 2` 
 notificationsoff
 ++++++++++++++++
 Turns off level up messages
 ::
    
-setcooldown
-+++++++++++
-Set the time in seconds between messages before xp is calculated again
+toggle
+++++++
+Toggle dozer ranks
 ::
    
-keeproles
-+++++++++
-Toggles whenever old level role roles will be kept on level up
+view_config
++++++++++++
+Shows dozer ranks:tm: config.
 ::
    
 removerolelevel
 +++++++++++++++
 Removes a levelrole
 ::
    `{prefix}removerolelevel level 2 `: Will remove role "level 2" from level roles
-toggle
-++++++
-Toggle dozer ranks
-::
-   
-setrolelevel
-++++++++++++
-Sets a role to be given to a user when they reach a certain level
-::
-   `{prefix}setrolelevel "level 2" 2`: Will configure the role "level 2" to be given to users who reach level 2` 
-notificationchannel
-+++++++++++++++++++
-Set up the channel where level up messages are sent
+keeproles
++++++++++
+Toggles whenever old level role roles will be kept on level up
 ::
    
-xprange
-+++++++
-Set the range of a servers levels random xp
+setcooldown
++++++++++++
+Set the time in seconds between messages before xp is calculated again
 ::
    
 rank

docs/Management.rst

@@ -12,14 +12,14 @@ list
 Displays currently scheduled messages
 ::
    `{prefix}schedulesend list`: Lists all scheduled messages for the current guild
+delete
+++++++
+Delete a scheduled message
+::
+   `{prefix}schedulesend delete 5`: Deletes the scheduled message with the ID of 5
 add
 +++
 Allows a message to be sent at a particular time Headers are
 distinguished by the characters `-/-`
 ::
    `{prefix}schedulesend add #announcments "1/0/1970 0:00:00 GMT" Epoch -/- 00000`: Dozer will send a message on the unix epoch in #announcments
-delete
-++++++
-Delete a scheduled message
-::
-   `{prefix}schedulesend delete 5`: Deletes the scheduled message with the ID of 5

docs/Moderation.rst

@@ -63,7 +63,7 @@ reading messages.
 selfdeafen
 ++++++++++
 Deafen yourself for a given time period to prevent you from reading or
-sending messages; useful as a study tool.
+sending messages.
 ::
    `{prefix}selfdeafen time (1h5m, both optional) reason`: deafens you if you need to get work done
 undeafen
@@ -87,6 +87,12 @@ modlogconfig
 Set the modlog channel for a server by passing the channel id
 ::
    `{prefix}modlogconfig #join-leave-logs` - set a channel named #join-leave-logs to log joins/leaves 
+verifymember
+++++++++++++
+Command to verify a member who may not have a team number set, or who
+hasn't sent the required verification message.
+::
+   
 nmconfig
 ++++++++
 Sets the config for the new members channel
@@ -121,6 +127,12 @@ safe default role conventions that the memberconfig command does.
 `{prefix}linkscrubconfig @ everyone` - set the default role as the link role (ping-safe)
 `{prefix}linkscrubconfig @.everyone` - set the default role as the link role (ping-safe)
 `{prefix}linkscrubconfig @/everyone` - set the default role as the link role (ping-safe)
+say_the_line
+++++++++++++
+Says the line. "Welcome to the server! Please set your team affiliation
+in your nickname."
+::
+   `{prefix}say_the_line @tweirtx` - Says the line mentioning @tweirtx
 crossbans
 +++++++++
 Cross ban
@@ -136,3 +148,8 @@ unsubscribe
 Remove cross ban subscription
 ::
    
+view_subs
++++++++++
+View crossban subscriptions for the current server
+::
+   

docs/Modmail.rst

@@ -0,0 +1,28 @@
+=======
+Modmail
+=======
+reply
++++++
+Command to reply to a modmail thread.
+::
+   
+configure_modmail
++++++++++++++++++
+Modmail configuration command. target_channel may be in another guild.
+::
+   
+start_modmail_with_user
++++++++++++++++++++++++
+Start modmail with a user, should be used in channel with modmail button
+::
+   
+create_modmail_button
++++++++++++++++++++++
+Creates modmail button
+::
+   
+modmail_close
++++++++++++++
+Closes modmail threads
+::
+