notif

A package to send notification from a python script

https://github.com/davebulaval/notification

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.0%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

A package to send notification from a python script

Basic Info
  • Host: GitHub
  • Owner: davebulaval
  • License: lgpl-3.0
  • Language: Python
  • Default Branch: master
  • Homepage: https://notificationdoc.ca/
  • Size: 5.79 MB
Statistics
  • Stars: 12
  • Watchers: 1
  • Forks: 2
  • Open Issues: 4
  • Releases: 21
Created almost 7 years ago · Last pushed over 2 years ago
Metadata Files
Readme Funding License Citation

README.md

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/notif)](https://pypi.org/project/notif/) [![PyPI Status](https://badge.fury.io/py/notif.svg)](https://badge.fury.io/py/notif) [![PyPI Status](https://pepy.tech/badge/notif)](https://pepy.tech/project/notif) [![Continuous Integration](https://github.com/davebulaval/notification/workflows/Continuous%20Integration/badge.svg)](https://github.com/davebulaval/notification/actions?query=workflow%3A%22Continuous+Integration%22+branch%3Amaster) [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0) [![codecov](https://codecov.io/gh/davebulaval/notification/branch/master/graph/badge.svg?token=43ARF9LF94)](https://codecov.io/gh/davebulaval/notification) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/91d7eb5c9d974a27a484866fe54635a8)](https://www.codacy.com/gh/davebulaval/notification/dashboard?utm_source=github.com&utm_medium=referral&utm_content=davebulaval/notification&utm_campaign=Badge_Grade)

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:

shell script pip install notif

  • Install the latest version of notif:

shell script 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.

Owner

  • Name: David Beauchemin
  • Login: davebulaval
  • Kind: user
  • Location: Quebec, Quebec
  • Company: Baseline.québec

Ph.D. candidate in legal NLP at University Laval. Founding members of @dot-layer and @Baseline-quebec

Citation (CITATION.cff)

cff-version: 1.2.0
preferred-citation:
  type: misc
  message: "If you use Notif, please cite it as below."
  authors:
  - family-names: "Beauchemin"
    given-names: "David"
  title: "Notif - The Notification Package"
  url: "https://notificationdoc.ca/"
  year: 2019

GitHub Events

Total
Last Year

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 131 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 21
  • Total maintainers: 1
pypi.org: notif

The notification package for every python project

  • Versions: 21
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 131 Last month
Rankings
Dependent packages count: 10.0%
Dependent repos count: 21.7%
Average: 22.9%
Downloads: 36.9%
Maintainers (1)
Last synced: 11 months ago

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v3.1.1 composite
  • peaceiris/actions-gh-pages v3 composite
.github/workflows/codeql-analysis.yml actions
  • actions/checkout v3 composite
  • github/codeql-action/analyze v2 composite
  • github/codeql-action/init v2 composite
.github/workflows/python-publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
docs/requirements.txt pypi
  • sphinx *
  • sphinx_rtd_theme *
requirements.txt pypi
  • notify_run *
  • pymsteams *
  • requests ==2.28.1
  • setuptools *
setup.py pypi
  • requests *
styling_requirements.txt pypi
  • black ==22.12.0
  • pylint ==2.15.9
  • pylint-django *
tests/requirements.txt pypi
  • pytest * test
  • pytest-cov * test
pyproject.toml pypi