py-reminder 0.0.1

A decorator for monitoring your task

py_reminder

This is a Python package that can send email for various purpose.

Introduction

Often times we have some time-consuming task, and we want to leave it run alone without staring at the screen for 7*24 hours.

This package will offer you a simplified experience of sending you email report with customized information.

Installation

pip install -U py_reminder

Initial configuration

You will suggest to use a unimportant mail box to receive message, since the password is going to store in plain text. (or if someone knows how to encrypt, please help!)

For the first time, you should specify configuration

from py_reminder import config

config(address='[e-mail]',
       password='123456',
       smtp='smtp.example.com',
       port=999,
       default_to='[e-mail]')

You can ignore default_to. It will set to be the same as address by default.

If you receive a testing email, then the configuration is done. You can never include this code thereafter.

Sample code

from py_reminder import monitor

@monitor(task='do something', to='[e-mail]')
def foo()
  time.sleep(10)
  return 0

foo() 

You can ignore to if you send to your default receiver. So the most simple way to use this decorator is:

@monitor('do something')