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 Pypi total project downloads

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

A special callback for Keras is now available to get automatic reports for the training of a model.

Setup

Just run:

pip install notipy_me

The keras callback will be automatically available if tensorflow is installed.

Preview

There are 4 emails types:

  • start: notify the recipients that the task has started.
  • report: send out the logged reports after a given interval.
  • exception: notify the recipients that the task has been interrupted.
  • completed: notify the recipients that the task has completed.

preview

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
from time import sleep
import pandas as pd

with Notipy() as ntp:
    for i in range(1000):
        ntp.add_report(pd.DataFrame({
            "test":[2]
        }))
        sleep(1)

Usage in a Keras model

from notipy_me import KerasNotipy

my_keras_model = build_my_keras_model(...)
my_keras_model.fit(
    X, y,
    callbacks=[
        KerasNotipy(
            task_name="Training BERT"
        )
    ]
)

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 every setting except for the password.

usage

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.

Files for notipy-me, version 1.3.23
Filename, size File type Python version Upload date Hashes
Filename, size notipy_me-1.3.23.tar.gz (10.8 kB) File type Source Python version None Upload date Hashes View

Supported by

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