Skip to main content

A pytest plugin to notify test results to a Discord channel.

Project description

Summary

PyPI package version Supported Python versions Supported Python implementations Linux/macOS/Windows CI status

A pytest plugin to notify test results to a Discord channel.

Installation

pip install pytest-discord

Quick start

Usage

Set a webhook URL when executing pytest via --discord-webhook option:

$ pytest --discord-webhook=<https://discordapp.com/api/webhooks/...>
https://github.com/thombashi/pytest-discord/blob/master/ss/pytest-discord.png

Notification message example

Or, set a webhook URL to an environment variable PYTEST_DISCORD_WEBHOOK:

$ export PYTEST_DISCORD_WEBHOOK=<https://discordapp.com/api/webhooks/...>
$ pytest

Or, you can specify webhook URL of a discord channel via ini-options (described later).

Increse the verbosity level

$ pytest --discord-verbose=1
https://github.com/thombashi/pytest-discord/blob/master/ss/pytest-discord_verbose.png

Notification message example

Notification messages may omit information caused by Discord limitations (especially when errors occurred). You can get full messages as an attached markdown file with --discord-attach-file option

Options

Command options

notify test results to a discord channel:
  --discord-webhook=WEBHOOK_URL
                        discord webhook url of a discord channel to notify
                        pytest results. you can also specify the value with
                        PYTEST_DISCORD_WEBHOOK environment variable.
  --discord-verbose=VERBOSITY_LEVEL
                        verbosity level for pytest-discord. if not set, using
                        verbosity level of pytest.
                        defaults to 0.
                        you can also specify the value with
                        PYTEST_DISCORD_VERBOSE environment variable.
  --discord-username=DISCORD_USERNAME
                        name for a message. defaults to pytest-discord. you can
                        also specify the value with PYTEST_DISCORD_USERNAME
                        environment variable.
  --discord-success-icon=ICON_URL
                        url to an icon of a successful run. you can also specify
                        the value with PYTEST_DISCORD_SUCCESS_ICON environment
                        variable.
  --discord-skip-icon=ICON_URL
                        url to an icon of a skipped run. you can also specify
                        the value with PYTEST_DISCORD_SKIP_ICON environment
                        variable.
  --discord-fail-icon=ICON_URL
                        url to an icon of a failed run. you can also specify the
                        value with PYTEST_DISCORD_FAIL_ICON environment
                        variable.
  --discord-attach-file
                        post pytest results as a markdown file to a discord
                        channel. you can also specify the value with
                        PYTEST_DISCORD_ATTACH_FILE environment variable.

ini-options

[pytest] ini-options in the first pytest.ini/tox.ini/setup.cfg/pyproject.toml (pytest 6.0.0 or later) file found:

discord_webhook (string):
                      discord webhook url of a discord channel to notify
                      pytest results.
discord_verbose (string):
                      verbosity level for pytest-discord. if not set, using
                      verbosity level of pytest. defaults to 0.
discord_username (string):
                      name for a message. defaults to pytest-discord.
discord_success_icon (string):
                      url to an icon of a successful run.
discord_skip_icon (string):
                      url to an icon of a skipped run.
discord_fail_icon (string):
                      url to an icon of a failed run.
discord_attach_file (bool):
                      post pytest results as a markdown file to a discord
                      channel.
Example of pyproject.toml:
 
[tool.pytest.ini_options]
discord_webhook = "https://discordapp.com/api/webhooks/..."
md_report_verbose = 1
Example of setup.cfg:
 
[tool:pytest]
discord_webhook = https://discordapp.com/api/webhooks/...
md_report_verbose = 1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pytest-discord, version 0.0.5
Filename, size File type Python version Upload date Hashes
Filename, size pytest_discord-0.0.5-py3-none-any.whl (10.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pytest-discord-0.0.5.tar.gz (12.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page