Merge pull request #11 from csp-community/tkp/docs

Update documentation

Author: timkpaine

README.md

@@ -9,6 +9,40 @@ Miscellaneous commands for csp-bot
 
 ## Overview
 
+This package contains fun, testing, and utility commands for [csp-bot](http://github.com/Point72/csp-bot/).
+
+| Command      | Type      | Description                                                                                          |
+| :----------- | :-------- | :--------------------------------------------------------------------------------------------------- |
+| `/slap`      | `fun`     | Slap someone with a [wet trout](https://en.wikipedia.org/wiki/Wikipedia:Whacking_with_a_wet_trout)   |
+| `/mets`      | `utility` | Get information about the NY Mets baseball team, including roster, players, and schedule information |
+| `/thanks`    | `fun`     | Thank another user with a random object or cash                                                      |
+| `/_fun`      | `fun`     | Randomly generated/selected quotes or trivia                                                         |
+| `/delaytest` | `test`    | Tester command for delayed/repeated commands                                                         |
+
+Any of these commands can be included in a `csp-bot` configuration [following the documentation](https://github.com/Point72/csp-bot/wiki/Overview#writing-commands):
+
+```yaml
+# @package _global_
+defaults:
+  - /gateway: slack
+  - _self_
+
+bot_name: CSP Bot
+app_token: .slack_app_token
+bot_token: .slack_bot_token
+
+gateway:
+  _target_: csp_bot.Gateway
+  modules:
+    - /modules/bot
+  commands:
+    - /commands/help
+    - _target_: csp_bot_commands.DelayTestCommandModel
+    - _target_: csp_bot_commands.FunCommandModel
+    - _target_: csp_bot_commands.MetsCommandModel
+    - _target_: csp_bot_commands.ThanksCommandModel
+    - _target_: csp_bot_commands.TroutSlapCommandModel
+```
 
 > [!NOTE]
 > This library was generated using [copier](https://copier.readthedocs.io/en/stable/) from the [Base Python Project Template repository](https://github.com/python-project-templates/base).

csp_bot_commands/mets.py

@@ -3,15 +3,21 @@
 
 from csp_bot import BaseCommand, BaseCommandModel, BotCommand, Message, ReplyToOtherCommand
 
+log = logging.getLogger(__name__)
+
 try:
     import lxml  # noqa: F401
     import pandas
 
     # Required for pandas functions we use
     import tabulate  # noqa: F401
 except ModuleNotFoundError:
+    # If pandas is not installed, we set it to None
     pandas = None
 
+    # Log a warning if pandas is not available
+    log.warning("pandas is not installed, `/mets` commands will not function properly.")
+
 __all__ = (
     "get_stats",
     "get_roster",
@@ -20,7 +26,6 @@
     "MetsCommand",
     "MetsCommandModel",
 )
-log = logging.getLogger(__name__)
 
 
 def get_stats():