Skip to content

davebulaval/notification

Repository files navigation

PyPI - Python Version PyPI Status PyPI Status Continuous Integration License: GPL v3 codecov Codacy Badge

Notif - The Notification Package for Every Python Project

Notif is an easy-to-use package to send notifications from a Python script.

Use this package to send during, at the end or when failing of a Python script a

- Slack notification,
- Email notification,
- Channel notification,
- Microsoft Teams notification,
- Discord.

Please be careful with your login credential. Use a .env or any other file not published by your Git (configured in .gitignore). Read the following for best practices.

Read the documentation at notificationdoc.ca.

Notif is compatible with the latest version of Python >= 3.7.


Installation

  • Install the stable version of notif:
pip install notif
  • Install the latest version of notif:
pip install -U git+https://github.com/davebulaval/notification.git

Cite

Use the following for the package citation;

@misc{notif,
    title={{Notif - The Notification Package}},
    author={David Beauchemin},
    year={2019},
    note   = {\url{https://notificationdoc.ca/}}
}

License

Notif is LGPLv3 licensed, as found in the LICENSE file.