discord-notify 1.0.0

A minimal Discord API webhooks wrapper for sending messages to a Discord channel

discord_notify

discord_notify is a minimal Discord API webhooks wrapper for easily sending messages to a Discord channel.

Use Cases

• Remote logging for lengthy Python scripts, such as:
  • Providing notifications during neural network training (e.g. logging validation accuracy after each training epoch)
  • Providing notifications on the status of a Python web server
• Regularly displaying information on a Discord channel without configuring a bot

Installation

pip install discord_notify

Usage

First, you'll need to create a new webhook for one of your Discord channels (Edit Channel > Integrations > Webhooks).

Then you can use this webhook in your code by creating an instance of the Notifier class and using the webhook's URL:

import discord_notify as dn

notifier = dn.Notifier(URL)

Sending Messages Once

Messages can be sent through the webhook by using the send method of the Notifier class.

notifier.send("Hello, world!", print_message=False)

• print_message indicates whether or not the provided message should be printed to the console. It defaults to True.

Sending Messages Repeatedly

The send_repeat method can be used to send messages over a regular interval of time.

x = 0
notifier.send_repeat(lambda: x, 1.5, print_message=False)
while x < 100000:
    x += 0.0001

The first parameter is a callable that returns the value to send, and the second parameter is the number of seconds to wait between webhook executions.

The method's daemon parameter can be set to False, forcing the timer thread to be stopped manually with the stop_repeat method. This requires a timer_id which is returned from send_repeat:

x = 0
timer_id = notifier.send_repeat(
    lambda: x,
    1.5,
    print_message=False,
    daemon=False
)
while x < 100000:
    x += 0.0001
    if x > 10000:
        notifier.stop_repeat(timer_id)