Discordit

Send Discord messages through an incoming webhook.

Install

pip install lupaxa-discordit
discordit --help

CLI

discordit --webhook "$DISCORD_WEBHOOK_URL" --text "Hello"
discordit --profile testing --text "Hello"
discordit -p alerts --config "$HOME/work/discordit.yml" --text "Disk full"
python -m lupaxa.discordit --version

The webhook URL must use Discord's /api/webhooks/ path. --text, --embed, and --file may be combined. --validate cannot be combined with them. One of those four is required. Flags override the same fields from the selected profile.

Config

Profiles live in $HOME/.discordit.yml. Pass --config to use another file. --config requires --profile.

profiles:
  testing:
    webhook_url: https://discord.com/api/webhooks/WEBHOOK_ID/WEBHOOK_TOKEN
    username: PyBot
    avatar_url: https://example.com/avatar.png
    tts: false
    thread_name: Alerts
    allowed_mentions:
      parse: []
    timeout: 15

Each profile may set webhook_url, username, avatar_url, tts, thread_name, allowed_mentions, and timeout.

Library

from lupaxa.discordit import Discordit, load_profile

profile = load_profile("testing")
client = Discordit(
    profile.webhook_url,
    username=profile.username,
    avatar_url=profile.avatar_url,
)
client.send_message("Hello")

Development

make init
make python-install-dev
make python-check

Documentation

Site pages live in mkdocs/ and publish to https://discordit.thelupaxaproject.org/.

make init
make python-install-dev
make mkdocs-serve