Requirements

• Python >= 3.6 (see badges above) (Python 3.5.3 would technically be possible, but does not support PEP 498 f-Strings, so a large portion of the string formatting would need rewrites.)

• discord.py

Installation

python3 -m pip install discord-notifier-bot

Optionally, install it locally with --user.

Configuration

Configuration is done by placing a .dbot.conf file in one of the following directories:

• $HOME/.dbot.conf

• $HOME/dbot.conf

• ./.dbot.conf

• ./dbot.conf

• /etc/dbot.conf

Alternatively a configuration file can be provided via -c/--config CLI options.

The configuration file should be a standard INI file. A template can be found in the templates folder. All configurations are placed under the discord-bot section.

Example:

[discord-bot]
# the bot token (used for login)
token = abc
# the numeric id of a channel, can be found when activating the developer options in appearances
channel = 123

Usage

dbot-message and dbot-file are simpler versions of dbot-run.

Print help and available options:

dbot-run -h

Sending messages:

# send a simple message
dbot-run message "Test message"
# or shorter:
dbot-message "Test **message**"

# pipe output
echo "Test" | dbot-emessage -

# wrap it inside a code-block ```
# optionally with a type
cat `which dbot-message` | dbot-message - --type
cat `which dbot-message` | dbot-message - --type python

Sending a file:

dbot-file README.rst "Your message to desribe the attached file"
# or with no visible message:
dbot-file README.rst ""

# optionally also like this:
dbot-run file -f README.rst "Message ..."

You are always able to specify the configuration file like this:

dbot-run -c /path/to/dbot.conf [...]
dbot-{message,file} -c /path/to/dbot.conf [...]

Only with dbot-run: To display debugging information (api calls, log messages etc.):

dbot-run -d [...]

You may also run the bot with the python module notation. But it will only run the same entry-point like dbot-run.

python -m discord_notifier_bot [...]

Full CLI help message:

usage: dbot-run [-h] [--type [TYPE]] [-f FILE] [-c CONFIG] [-d]
                {message,file} message

positional arguments:
  {message,file}        Bot action
  message               Message to send

optional arguments:
  -h, --help            show this help message and exit
  --type [TYPE]         Markdown type for text messages, or default if as flag
  -f FILE, --file FILE  Optional file to attach to message
  -c CONFIG, --config CONFIG
                        Config file
  -d, --debug           Enable debug logging

usage: dbot-file [-h] [-c CONFIG] file message

positional arguments:
  file
  message

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG, --config CONFIG
                        Config file

usage: dbot-message [-h] [-c CONFIG] [--type [TYPE]] message

positional arguments:
  message

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG, --config CONFIG
                        Config file
  --type [TYPE]         Markdown type, or default if without value

from discord_notifier_bot.cli import setup_logging, load_config

# logging (rather basic, if needed)
setup_logging(True)

# load configuration file (provide filename or None)
configs = load_config(filename=None)

from discord_notifier_bot.bot import send_message

# message string with basic markdown support
message = "The **message** to `send`"
# bot token and channel_id (loaded from configs or hard-coded)
bot_token, channel_id = configs["token"], configs["channel"]
# send the message
send_message(bot_token, channel_id, message)

Bot Creation etc.

See information provided by:

• Tutorial for setting up a bot

• Discord developer application page

Related

• Discord-System-Observer-Bot, for observing local machine status and getting messages on resource exhaustion (former 0.2.x version code, refactored in its own package for cleaner packages)

• python-discord-webhook, a python module (+ CLI) to use Discord webhooks to send messages, (webhooks would be a more restrictive way as they are bound to a single channel and are just a simple HTTP request, so more data friendly. You may want to check it out.)

Credits

• easy-telegram-cli

Copyright and License Information

Copyright (c) 2020 Erik Körner. All rights reserved.

See the file “LICENSE” for information on the history of this software, terms & conditions for usage, and a DISCLAIMER OF ALL WARRANTIES.

All trademarks referenced herein are property of their respective holders.