Skip to main content

Notify google chat channel for test results

Project description


PyPI version

Python versions

Notify google chat channel for test results

🧰 Installation

You can install pytest-google-chat via pip from PyPI:

$ pip install pytest-google-chat

📖 Usage

In order to use this plugin, you need to provide the command line flag --google-chat and a valid goggle chat webhook. The webhook, as all the other parameters, can be provided as a command line argument, as a value inside a config file or as an environment variable.

Command line options

Option Description Default value
--google-chat Enable the plugin (required) This doesn't need a value
--gc-webhook The webhook to send notifications to.
Important: Use double or single quotes for the value
--report-link The link to the report None
--report-title The title of the report None
--report-subtitle The subtitle of the report None
--gc-fail-image The url of an image to use when the test fails None
--gc-success-image The url of an image to use when the test succeeds None
--gc-config The path to the config file None

Using a config file

report_title=My Report
report_subtitle=My Report Subtitle

Using environment variables:

REPORT_TITLE="My Report" pytest --google-chat --gc-webhook=https://....

NOTE All previous methods can be used combined. The order of precedence is: command line options > config file > environment variable.


Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.


Distributed under the terms of the MIT license, "pytest-google-chat" is free and open source software.


If you encounter any problems, please file an issue along with a detailed description.

This pytest plugin was generated with Cookiecutter along with @hackebrot's cookiecutter-pytest-plugin template.

Project details

Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

pytest_google_chat-0.4.4-py3-none-any.whl (7.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page