cogwatch 1.1.0

Automatic hot-reloading for your discord.py command files.

cogwatch

Automatic hot-reloading for your discord.py command files.

cogwatch is a utility that you can plug into your discord.py bot that will watch your command files directory (cogs) and automatically reload them as you modify or move them around in real-time. No more manually reloading commands with other commands, or (worse) restarting your bot, every time you edit that embed!

Getting Started

You can install the library with pip install cogwatch.

You can import and start the watcher anywhere you want, as long as you have access to your initialized bot class. The on_ready method makes a good, generic location. The first two arguments are required. The first is your bot instance. The second is the name of the directory where your command files exist. All other arguments are optional.

from cogwatch import watch

@watch()
async def on_ready(self):
    pass

By default the library will use the running event loop. If you wish to pass in a specific loop, you can do so with the loop=None parameter.

NOTE: cogwatch will only run if the __debug__ flag is set on Python. You can read more about that here. In short, unless you run Python with the -O flag from your command line, __debug__ will be True. If you just want to bypass this feature, pass in debug=False and it won't matter if the flag is enabled or not. This is a development tool. You should not run it on production.

There is a complete example bot in the examples/ directory that shows all the arguments.

Logging

By default the library has a logger enabled so users can get output to the console. You can disable this by passing in default_logger=False. If you want to hook into the logger -- for example, to pipe your output to another terminal or tail a file -- you can set up a custom logger like so:

import logging
import sys

watch_log = logging.getLogger('cogwatch')
watch_log.setLevel(logging.INFO)
watch_handler = logging.StreamHandler(sys.stdout)
watch_handler.setFormatter(logging.Formatter('[%(name)s] %(message)s'))
watch_log.addHandler(watch_handler)