Getting ready for the help command

Author: ntvmb

.gitignore

@@ -1,11 +1,9 @@
 build
 dist
 cyclomonitor.code-workspace
-src/cyclomonitor/__pycache__/
-src/cyclomonitor/ibtracs/__pycache__/
-src/cyclomonitor/locales/__pycache__/
-src/cyclomonitor/ibtracs/locales/__pycache__/
+**/__pycache__/
 src/cyclomonitor/ibtracs/BestTrack.db
 src/cyclomonitor.egg-info
 src/cyclomonitor/locales/es_US.json
 **/*.log
+.venv

privacy-policy.md

@@ -8,6 +8,7 @@ CycloMonitor stores the following information:
 - Users**
   - Username
   - Discriminator (if applicable)
+  - ID
   - Most recently used command
 
 *Required  

pyproject.toml

@@ -32,7 +32,7 @@ dependencies = [
 ]
 requires-python = ">=3.8"
 classifiers = [
-    "Development Status :: 3 - Alpha",
+    "Development Status :: 4 - Beta",
     "Intended Audience :: Developers",
     "Topic :: Internet",
     "Topic :: Scientific/Engineering",

src/cyclomonitor/cyclomonitor.py

@@ -795,7 +795,7 @@ async def statistics(ctx):
 
 
 @bot.slash_command(name="yikes", description=CM_YIKES)
-async def yikes(ctx):
+async def yikes(ctx: discord.ApplicationContext):
     await ctx.defer(ephemeral=True)
     count = global_vars.get("yikes_count")
     if count is not None:
@@ -808,8 +808,8 @@ async def yikes(ctx):
         channel = bot.get_channel(channel_id)
         if channel is not None:
             await channel.send(CM_INC_YIKES_COUNT.format(count))
-    logging.info(CM_INC_YIKES_COUNT)
-    await ctx.respond(CM_YIKES_RESPONSE)
+    logging.info(CM_INC_YIKES_COUNT.format(ctx.author, ctx.author.id))
+    await ctx.respond(CM_YIKES_RESPONSE.format(count))
 
 
 @bot.slash_command(name="get_data", description=CM_GET_DATA)

src/cyclomonitor/locales/C.json

@@ -93,7 +93,7 @@
     "ERROR_NO_GLOBAL_VARS": "Could not get global variables.",
     "CM_STATISTICS": "# CycloMonitor statistics\nCurrently serving {0} guilds, totaling {4}\\* members.\n\\*This is an estimate which may not accurately reflect the true number of members being served.\n\nStrongest cyclone recorded by this bot: {1[0]} {1[1]} {1[2]} ({1[3]})\n- Wind peak: {1[5]} kt ({1[6]} mph/{1[7]} kph)\n- Pressure peak: {1[8]} mb\n- Time recorded: <t:{1[4]}:f>\nCurrent yikes counter: {2}\nBot uptime: {3}",
     "CM_YIKES": "Yikes!",
-    "CM_INC_YIKES_COUNT": "The yikes count is now {0}!",
+    "CM_INC_YIKES_COUNT": "{0} ({1}) has incremented the yikes counter!",
     "CM_YIKES_RESPONSE": "# Yikes!\nThe yikes count is now {0}!",
     "CM_GET_DATA": "Get the latest ATCF data without triggering an update",
     "CM_GET_DATA_SUCCESS": "ATCF data downloaded.\n{0}",
@@ -195,7 +195,7 @@
     "CM_EXTENDED_ANNOUNCE_FILE": "This command works similarly to `/announce_all`, but uses the contents of an attached text file to send a message.",
     "CM_EXTENDED_INVITE": "This command sends a link you can use to add the bot to your server.",
     "CM_EXTENDED_STATISTICS": "This command allows you to view CycloMonitor's globally tracked statistics: that among those are the server count, the total member count, the strongest storm, the yikes counter, and the bot's uptime.",
-    "CM_EXTENDED_YIKES": "This command increments the global yikes counter. The yikes counter is then announced to all servers CycloMonitor is in.\nUse this command when something happens that makes you say \"Yikes!\"",
+    "CM_EXTENDED_YIKES": "This command increments the global yikes counter. The yikes counter is then announced to all servers CycloMonitor is in.\nUse this command when something happens that makes you say \"Yikes!\" It does not have to be related to tropical cyclones. **Inappropriate use of this command will result in a ban from further use.**",
     "CM_EXTENDED_GET_DATA": "This command is used by the bot owner to download the latest ATCF data without running the automatic update routines.",
     "CM_EXTENDED_GET_DATA_ALT": "This command is used by the bot owner to download the latest ATCF data from the alternate source without running the automatic update routines.",
     "CM_EXTENDED_ATCF_RESET": "This command is used by the bot owner to clear the bot's cached ATCF data.",
@@ -210,5 +210,32 @@
     "CM_EXTENDED_SET_LANGUAGE": "This command sets the language CycloMonitor will use in this server. Currently, only English is supported. To translate CycloMonitor to other languages, add a file to `src/cyclomonitor/locales` in CycloMonitor's GitHub repository (see `/github`) and use `en_US.json` or `C.json` as a base.",
     "CM_EXTENDED_GET_FORECAST": "This command sends the forecast image for a specified active storm. The image will be from NHC/CPHC if the storm is in the North Atlantic, Eastern Pacific, or Central Pacific, and it will be from JTWC otherwise. This command cannot be used if there are no active storms.",
     "CM_EXTENDED_SERVER": "This command sends an invite link to CycloMonitor's official server.",
-    "CM_EXTENDED_CONTACT_GUILD": "This command is used by the bot owner to send a message to a specific server in the hopes of getting a staff member's attention in case of a server-specific problem (i.e. configuration errors)."
+    "CM_EXTENDED_CONTACT_GUILD": "This command is used by the bot owner to send a message to a specific server in the hopes of getting a staff member's attention in case of a server-specific problem (i.e. configuration errors).",
+    "CM_HELP_GENERAL": "Stop it. Get some help.",
+    "CM_HELP_ALL": "Full list of commands",
+    "CM_HELP_COMMON": "List of common commands",
+    "CM_HELP_USEFUL": "List of useful commands",
+    "CM_HELP_ADMIN": "Full list of administration commands",
+    "CM_HELP_CONFIG": "List of configuration commands",
+    "CM_HELP_INTERNAL": "List of internal commands",
+    "CM_HELP_COMMAND": "Show detailed information about a command",
+    "CM_EXTENDED_HELP_GENERAL": "This command shows the primary help page, providing a list of other help pages, each showing a (sub)set of commands.",
+    "CM_EXTENDED_HELP_ALL": "This command shows a list of all commands except for internal commands.",
+    "CM_EXTENDED_HELP_COMMON": "This command shows a list of common commands, which are commands that anyone can use.",
+    "CM_EXTENDED_HELP_USEFUL": "This command shows a list of useful commands, a subset of common commands that are deemed most useful for the bot functionality.",
+    "CM_EXTENDED_HELP_ADMIN": "This command shows a list of administration commands, which are commands that are intended to be used by server staff.",
+    "CM_EXTENDED_HELP_CONFIG": "This command shows a list of configuration commands, a subset of administration commands which are used to configure CycloMonitor.",
+    "CM_EXTENDED_HELP_INTERNAL": "This command shows a list of internal commands, which are commands that are only usable by the bot owner. **Such commands are listed for transparency purposes only, and any attempts to use them will be logged.**",
+    "CM_EXTENDED_HELP_COMMAND": "This command shows detailed information about the specified command, describing how to use it correctly and any parameters it has.",
+    "CM_GENERAL_HELP": "# General help\nThank you for using CycloMonitor. This bot is designed to make it easier to keep tabs on cyclones around the world. For further help, use one of the commands below:\n* `/help all` -- All commands\n* `/help common` -- Common commands\n  * `/help useful` -- Useful commands\n* `/help admin` -- Administration commands\n  * `/help config` -- Configuration commands\n* `/help internal` -- Internal commands\nFor more information on a specific command, use `/help command <command_name>`.",
+    "CM_COMMON_COMMANDS": "# Common commands\nThese commands are available to all users.\n",
+    "CM_USEFUL_COMMANDS": "# Useful commands\nThis is a subset of common commands denoting those that are most useful for the bot functionality.\n",
+    "CM_ADMIN_COMMANDS": "# Administration commands\nThese are commands that are intended to be used by server staff.\n",
+    "CM_CONFIG_COMMANDS": "# Configuration commands\nThis is a subset of administration commands used to configure CycloMonitor.\n",
+    "CM_INTERNAL_COMMANDS": "# Internal commands\nThese are commands that are only usable by the bot owner for testing and other nefarious uses. They are shown here for transparency purposes.\n",
+    "CM_ALL_COMMANDS": "# All commands\nAll commands except for internal commands (see `/help internal`). For more information on a specific command, use `/help command <command_name>`.\n",
+    "PARAMETERS": "Parameters:\n",
+    "HAS_NO_PARAMETERS": "This command does not take any additional parameters.",
+    "FOR_INTERNAL_USE_ONLY": "**This command is for internal use only. Attempts to use this command will be logged.**",
+    "MISSING_DESCRIPTION": "Missing extended description"
 }

src/cyclomonitor/locales/__init__.py

@@ -190,6 +190,61 @@
 CLI_OLD_PY_VERSION = "CLI_OLD_PY_VERSION"
 NEARLY_STATIONARY = "NEARLY_STATIONARY"
 STATIONARY = "STATIONARY"
+CM_EXTENDED_PING = "CM_EXTENDED_PING"
+CM_EXTENDED_SET_TRACKING_CHANNEL = "CM_EXTENDED_SET_TRACKING_CHANNEL"
+CM_EXTENDED_UPDATE = "CM_EXTENDED_UPDATE"
+CM_EXTENDED_UPDATE_ALT = "CM_EXTENDED_UPDATE_ALT"
+CM_EXTENDED_SET_BASINS = "CM_EXTENDED_SET_BASINS"
+CM_EXTENDED_UPDATE_ALL = "CM_EXTENDED_UPDATE_ALL"
+CM_EXTENDED_UPDATE_ALL_ALT = "CM_EXTENDED_UPDATE_ALL_ALT"
+CM_EXTENDED_ANNOUNCE_ALL = "CM_EXTENDED_ANNOUNCE_ALL"
+CM_EXTENDED_ANNOUNCE_BASIN = "CM_EXTENDED_ANNOUNCE_BASIN"
+CM_EXTENDED_ANNOUNCE_FILE = "CM_EXTENDED_ANNOUNCE_FILE"
+CM_EXTENDED_INVITE = "CM_EXTENDED_INVITE"
+CM_EXTENDED_STATISTICS = "CM_EXTENDED_STATISTICS"
+CM_EXTENDED_YIKES = "CM_EXTENDED_YIKES"
+CM_EXTENDED_GET_DATA = "CM_EXTENDED_GET_DATA"
+CM_EXTENDED_GET_DATA_ALT = "CM_EXTENDED_GET_DATA_ALT"
+CM_EXTENDED_ATCF_RESET = "CM_EXTENDED_ATCF_RESET"
+CM_EXTENDED_GITHUB = "CM_EXTENDED_GITHUB"
+CM_EXTENDED_COPYRIGHT = "CM_EXTENDED_COPYRIGHT"
+CM_EXTENDED_RSMC_LIST = "CM_EXTENDED_RSMC_LIST"
+CM_EXTENDED_GET_LOG = "CM_EXTENDED_GET_LOG"
+CM_EXTENDED_SUSPEND_UPDATES = "CM_EXTENDED_SUSPEND_UPDATES"
+CM_EXTENDED_RESUME_UPDATES = "CM_EXTENDED_RESUME_UPDATES"
+CM_EXTENDED_FEEDBACK = "CM_EXTENDED_FEEDBACK"
+CM_EXTENDED_GET_PAST_STORM = "CM_EXTENDED_GET_PAST_STORM"
+CM_EXTENDED_SET_LANGUAGE = "CM_EXTENDED_SET_LANGUAGE"
+CM_EXTENDED_GET_FORECAST = "CM_EXTENDED_GET_FORECAST"
+CM_EXTENDED_SERVER = "CM_EXTENDED_SERVER"
+CM_EXTENDED_CONTACT_GUILD = "CM_EXTENDED_CONTACT_GUILD"
+CM_HELP_GENERAL = "CM_HELP_GENERAL"
+CM_HELP_ALL = "CM_HELP_ALL"
+CM_HELP_COMMON = "CM_HELP_COMMON"
+CM_HELP_USEFUL = "CM_HELP_USEFUL"
+CM_HELP_ADMIN = "CM_HELP_ADMIN"
+CM_HELP_CONFIG = "CM_HELP_CONFIG"
+CM_HELP_INTERNAL = "CM_HELP_INTERNAL"
+CM_HELP_COMMAND = "CM_HELP_COMMAND"
+CM_EXTENDED_HELP_GENERAL = "CM_EXTENDED_HELP_GENERAL"
+CM_EXTENDED_HELP_ALL = "CM_EXTENDED_HELP_ALL"
+CM_EXTENDED_HELP_COMMON = "CM_EXTENDED_HELP_COMMON"
+CM_EXTENDED_HELP_USEFUL = "CM_EXTENDED_HELP_USEFUL"
+CM_EXTENDED_HELP_ADMIN = "CM_EXTENDED_HELP_ADMIN"
+CM_EXTENDED_HELP_CONFIG = "CM_EXTENDED_HELP_CONFIG"
+CM_EXTENDED_HELP_INTERNAL = "CM_EXTENDED_HELP_INTERNAL"
+CM_EXTENDED_HELP_COMMAND = "CM_EXTENDED_HELP_COMMAND"
+CM_GENERAL_HELP = "CM_GENERAL_HELP"
+CM_COMMON_COMMANDS = "CM_COMMON_COMMANDS"
+CM_USEFUL_COMMANDS = "CM_USEFUL_COMMANDS"
+CM_ADMIN_COMMANDS = "CM_ADMIN_COMMANDS"
+CM_CONFIG_COMMANDS = "CM_CONFIG_COMMANDS"
+CM_INTERNAL_COMMANDS = "CM_INTERNAL_COMMANDS"
+CM_ALL_COMMANDS = "CM_ALL_COMMANDS"
+PARAMETERS = "PARAMETERS"
+HAS_NO_PARAMETERS = "HAS_NO_PARAMETERS"
+FOR_INTERNAL_USE_ONLY = "FOR_INTERNAL_USE_ONLY"
+MISSING_DESCRIPTION = "MISSING_DESCRIPTION"
 
 _log = _logging.getLogger(__name__)
 locale.setlocale(locale.LC_ALL, "")

src/cyclomonitor/locales/en_US.json

@@ -93,7 +93,7 @@
     "ERROR_NO_GLOBAL_VARS": "Could not get global variables.",
     "CM_STATISTICS": "# CycloMonitor statistics\nCurrently serving {0} guilds, totaling {4}\\* members.\n\\*This is an estimate which may not accurately reflect the true number of members being served.\n\nStrongest cyclone recorded by this bot: {1[0]} {1[1]} {1[2]} ({1[3]})\n- Wind peak: {1[5]} kt ({1[6]} mph/{1[7]} kph)\n- Pressure peak: {1[8]} mb\n- Time recorded: <t:{1[4]}:f>\nCurrent yikes counter: {2}\nBot uptime: {3}",
     "CM_YIKES": "Yikes!",
-    "CM_INC_YIKES_COUNT": "The yikes count is now {0}!",
+    "CM_INC_YIKES_COUNT": "{0} ({1}) has incremented the yikes counter!",
     "CM_YIKES_RESPONSE": "# Yikes!\nThe yikes count is now {0}!",
     "CM_GET_DATA": "Get the latest ATCF data without triggering an update",
     "CM_GET_DATA_SUCCESS": "ATCF data downloaded.\n{0}",
@@ -195,7 +195,7 @@
     "CM_EXTENDED_ANNOUNCE_FILE": "This command works similarly to `/announce_all`, but uses the contents of an attached text file to send a message.",
     "CM_EXTENDED_INVITE": "This command sends a link you can use to add the bot to your server.",
     "CM_EXTENDED_STATISTICS": "This command allows you to view CycloMonitor's globally tracked statistics: that among those are the server count, the total member count, the strongest storm, the yikes counter, and the bot's uptime.",
-    "CM_EXTENDED_YIKES": "This command increments the global yikes counter. The yikes counter is then announced to all servers CycloMonitor is in.\nUse this command when something happens that makes you say \"Yikes!\"",
+    "CM_EXTENDED_YIKES": "This command increments the global yikes counter. The yikes counter is then announced to all servers CycloMonitor is in.\nUse this command when something happens that makes you say \"Yikes!\" It does not have to be related to tropical cyclones. **Inappropriate use of this command will result in a ban from further use.**",
     "CM_EXTENDED_GET_DATA": "This command is used by the bot owner to download the latest ATCF data without running the automatic update routines.",
     "CM_EXTENDED_GET_DATA_ALT": "This command is used by the bot owner to download the latest ATCF data from the alternate source without running the automatic update routines.",
     "CM_EXTENDED_ATCF_RESET": "This command is used by the bot owner to clear the bot's cached ATCF data.",
@@ -210,5 +210,32 @@
     "CM_EXTENDED_SET_LANGUAGE": "This command sets the language CycloMonitor will use in this server. Currently, only English is supported. To translate CycloMonitor to other languages, add a file to `src/cyclomonitor/locales` in CycloMonitor's GitHub repository (see `/github`) and use `en_US.json` or `C.json` as a base.",
     "CM_EXTENDED_GET_FORECAST": "This command sends the forecast image for a specified active storm. The image will be from NHC/CPHC if the storm is in the North Atlantic, Eastern Pacific, or Central Pacific, and it will be from JTWC otherwise. This command cannot be used if there are no active storms.",
     "CM_EXTENDED_SERVER": "This command sends an invite link to CycloMonitor's official server.",
-    "CM_EXTENDED_CONTACT_GUILD": "This command is used by the bot owner to send a message to a specific server in the hopes of getting a staff member's attention in case of a server-specific problem (i.e. configuration errors)."
+    "CM_EXTENDED_CONTACT_GUILD": "This command is used by the bot owner to send a message to a specific server in the hopes of getting a staff member's attention in case of a server-specific problem (i.e. configuration errors).",
+    "CM_HELP_GENERAL": "Stop it. Get some help.",
+    "CM_HELP_ALL": "Full list of commands",
+    "CM_HELP_COMMON": "List of common commands",
+    "CM_HELP_USEFUL": "List of useful commands",
+    "CM_HELP_ADMIN": "Full list of administration commands",
+    "CM_HELP_CONFIG": "List of configuration commands",
+    "CM_HELP_INTERNAL": "List of internal commands",
+    "CM_HELP_COMMAND": "Show detailed information about a command",
+    "CM_EXTENDED_HELP_GENERAL": "This command shows the primary help page, providing a list of other help pages, each showing a (sub)set of commands.",
+    "CM_EXTENDED_HELP_ALL": "This command shows a list of all commands except for internal commands.",
+    "CM_EXTENDED_HELP_COMMON": "This command shows a list of common commands, which are commands that anyone can use.",
+    "CM_EXTENDED_HELP_USEFUL": "This command shows a list of useful commands, a subset of common commands that are deemed most useful for the bot functionality.",
+    "CM_EXTENDED_HELP_ADMIN": "This command shows a list of administration commands, which are commands that are intended to be used by server staff.",
+    "CM_EXTENDED_HELP_CONFIG": "This command shows a list of configuration commands, a subset of administration commands which are used to configure CycloMonitor.",
+    "CM_EXTENDED_HELP_INTERNAL": "This command shows a list of internal commands, which are commands that are only usable by the bot owner. **Such commands are listed for transparency purposes only, and any attempts to use them will be logged.**",
+    "CM_EXTENDED_HELP_COMMAND": "This command shows detailed information about the specified command, describing how to use it correctly and any parameters it has.",
+    "CM_GENERAL_HELP": "# General help\nThank you for using CycloMonitor. This bot is designed to make it easier to keep tabs on cyclones around the world. For further help, use one of the commands below:\n* `/help all` -- All commands\n* `/help common` -- Common commands\n  * `/help useful` -- Useful commands\n* `/help admin` -- Administration commands\n  * `/help config` -- Configuration commands\n* `/help internal` -- Internal commands\nFor more information on a specific command, use `/help command <command_name>`.",
+    "CM_COMMON_COMMANDS": "# Common commands\nThese commands are available to all users.\n",
+    "CM_USEFUL_COMMANDS": "# Useful commands\nThis is a subset of common commands denoting those that are most useful for the bot functionality.\n",
+    "CM_ADMIN_COMMANDS": "# Administration commands\nThese are commands that are intended to be used by server staff.\n",
+    "CM_CONFIG_COMMANDS": "# Configuration commands\nThis is a subset of administration commands used to configure CycloMonitor.\n",
+    "CM_INTERNAL_COMMANDS": "# Internal commands\nThese are commands that are only usable by the bot owner for testing and other nefarious uses. They are shown here for transparency purposes.\n",
+    "CM_ALL_COMMANDS": "# All commands\nAll commands except for internal commands (see `/help internal`). For more information on a specific command, use `/help command <command_name>`.\n",
+    "PARAMETERS": "Parameters:\n",
+    "HAS_NO_PARAMETERS": "This command does not take any additional parameters.",
+    "FOR_INTERNAL_USE_ONLY": "**This command is for internal use only. Attempts to use this command will be logged.**",
+    "MISSING_DESCRIPTION": "Missing extended description"
 }