Skip to main content

Update notifications for your python app

Project description

Send a notification when there is an update available for your package! Py-port of update-notifier.

Install

pipenv install update_notipy

or

pip install update_notipy

Usage

from update_notipy import update_notify

update_notify(
    <pkg_name>,
    <pkg_version>,
    callback=<callback>,
    message=<message>,
    defer=<True|False>).notify()

Arguments

  • pkg_name: str: name of the package as registered on PyPI
  • pkg_version: str: version of the installed package, to be compared with the latest one
  • callback: Callable: function to be called instead of printing the standard message
  • message: str: custom message to be printed
  • defer: bool: set to True if you want to notify the user when the app closes

Examples

from update_notipy import update_notify

__version__ = "0.1.0"

update_notify('pkg-info', __version__).notify()

#    ┌───────────────────────────────────────────┐
#    │                                           │
#    │   Update available 0.1.0 → 0.1.2          │
#    │   Run pip install -U pkg-info to update   │
#    │                                           │
#    └───────────────────────────────────────────┘

def foo():
    four = 2 + 2
    print(four)

update_notify('pkg-info', __version__, callback=foo).notify()

# 4

update_notify('pkg-info', __version__, message="Hello, world!").notify()

# Hello, world!

Project details


Download files

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

Files for update-notipy, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size update_notipy-0.1.2-py2-none-any.whl (4.2 kB) File type Wheel Python version py2 Upload date Hashes View
Filename, size update_notipy-0.1.2-py3.6.egg (2.5 kB) File type Egg Python version 3.6 Upload date Hashes View
Filename, size update_notipy-0.1.2-py3-none-any.whl (4.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size update-notipy-0.1.2.tar.gz (2.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page