Skip to main content

A simple python package to send you and any other receiver an email when a portion of code is done running.

Project description

sonar_quality sonar_maintainability sonar_coverage pip

A simple python package to send you and any other receiver an email when a portion of code is done running.

Setup

Just run:

pip install notipy_me

Usage example

A basic usage example can be the following:

Usage as decorator

from notipy_me import Notipy

@Notipy
def my_long_running_script():
    ...

Usage as context

from notipy_me import Notipy

with Notipy() as NP:
    my_long_running_script()

Form example

When you run the script notipy will ask you to enter your email, password etc… it will store into a cache file called .notipy.json every setting except for the password.

The following example is from after having run the test once, so it loads everything except for the password from the cache:

Let's setup your notipy!
Hit enter to use the default values.
Please insert email [luca.cappelletti@my.email.it]:
Password:
Please insert task_name [Testing Notipy]:
Please insert recipients, separated by a comma [luca.cappelletti@my.email.it]:
Please insert report_timeout_unit, ('h', 'm', 's') [s]:
Please insert report_timeout, in seconds [120]:
Please insert port [465]:
Please insert smtp_server [smtp.email.it]:

Integration with travis

By default, when used on a system with no stdout to ask for input, notipy turns itself off.

Preview

You will receive mails such as the following (in both images the server name and email server has been deleted):

started completed

Known issues

Gmail

I cannot manage to get gmail to work, but it keeps rising an error logging in with the credentials, even though they are correct. With the other mail providers it works fine.

Project details


Download files

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

Source Distribution

notipy_me-1.2.14.tar.gz (9.4 kB view hashes)

Uploaded Source

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