Wowbot

---

Table of Contents

• Command Line Interface
• Hatch commands
• License

Command Line Interface

The package installs two commands:

• wowbot - runs the bot
  • Reads the DISCORD_BOT_TOKEN and WOWBOT_SOUNDS_DIR environmental variables
• wowbot-sounds - validates sounds
  • wowbot-sounds check FOLDER - validates a sound folder

Hatch commands

If you do not have hatch on your path, you can use pipx hatch or install it with pip install hatch.

• hatch run bot - runs the bot
• hatch run wowbot-sounds [args] - runs the sound validator
• hatch run test:cov - runs the tests, printing the coverage to the terminal
  • hatch run test:cov-file - write the coverage to an HTML file, and an XML file
  • hatch run test:no-cov - don't write coverage data
  • hatch run testall:cov - runs the tests in Python 3.8, 3.9, and 3.10
• hatch run docs:html - build the Sphinx documentation
  • hatch run docs:clean - remove the built documentation

License

wowbot is distributed under the terms of the MIT license.