Skip to content

Latest commit

 

History

History
276 lines (182 loc) · 8.69 KB

README.rst

File metadata and controls

276 lines (182 loc) · 8.69 KB
Raw

Discord-Notifier-Bot

GitHub release GitHub code size in bytes MHTML License PyPI supported Python versions Code style: black

A simple python Discord bot to send messages to Discord channel via command line.

It allows markdown formatted messages and attaching files.

It registers the following commands:

  • dbot-run - main CLI entry-point
  • dbot-message - (short-hand) to send a message, or even pipe - message contents
  • dbot-file - (short-hand) to send a file with an message

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

Embedded in other scripts

Sending messages is rather straightforward. More complex examples can be found in the CLI entrypoints, see file discord_notifier_bot.cli. Below are some rather basic examples (extracted from the CLI code).

Basic setup (logging + config loading):

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)

Sending a message:

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:

Short description

You have to own a Discord server! Or know someone with administrator/moderation(?) privileges.

  1. Visit and login to the Discord developer page.
  2. Create a new application. The given name is also the visible name of the bot. (default, can be changed later?)
  3. Create a bot (on the Bot page). You should disable the Public Bot option.
    • The bot login token (credentials) can be found on the Bot page.
  4. Change to the OAuth2 page and check
    • Scopes: Bot
    • Bot Permissions: Send Messages, Attach Files (in the Text Permissions column)
  5. Copy the URL in the Scopes section and paste it in a new browser tab.
    • Now you can choose one (?) of your own Discord servers to add the bot to. (For this you need server administration permissions, or be the owner..?)

To get the channel id, send the following message on your server \#channelname, or enable developer options. You may want to visit the following pages for more information:

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

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.