https://github.com/robertdavidwest/try_then_alert

https://github.com/robertdavidwest/try_then_alert

Last synced: about 10 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/robertdavidwest/try_then_alert
• Owner: robertdavidwest
• Created: 2015-09-22T18:52:20.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-02-01T20:49:55.000Z (almost 9 years ago)
• Last Synced: 2024-04-19T16:13:55.561Z (7 months ago)
• Language: Python
• Size: 9.77 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Try then alert

* Send your self an alert if your function call crashes or finishes successfully 

* Currently setup for gmail accounts only

## Dependencies 

* Install packages `email`, `smtblib`, `keyring`, `getpass` using:

		$ pip install 

				

## Installation

* Clone the repository

		$ git clone https://github.com/robertdavidwest/try_then_alert.git

* `cd` into `try_then_alert`

* Install the package

  

        $ python setup.py install

* Now you can `import try_then_alert` from anywhere on your machine

* You may also have to do this: Log into your gmail account in your browser and navigate to [https://www.google.com/settings/security/lesssecureapps](https://www.google.com/settings/security/lesssecureapps) and select **'Turn on'**

## First time use

`try_then_alert` will store your gmail credentials in the keyring so you can easily use in your code without having to hard code your gmail address and password. When used for the first time your we be prompted for these credentials. Afterwhich they will be stored in the keyring.

## Usage

This is designed to be used when you're running something that takes forever. You want to walk away from your computer and not think about it until it has finished running or if there has been an error. 

It's really to use. Just apply the wrapper to any function. Then when the function is called you will be alerted by email if there is an error in the execution, or, if the function call is successful depending on your preferences

		

* This will send an email alert to your gmail account if some_func has an error

		

		from try_then_alert import try_then_alert

	

		@try_then_alert

		def some_func():

			# do some important and time consuming stuff 

			

		if __name__ == '__main__':

			some_func()

* This will send an email alert to your gmail account if some_func runs successfully

			

		from try_then_alert import try_then_alert

	

		@try_then_alert(alert_on_error=False, alert_on_completion=True)

		def some_func():

			# do some important and time consuming stuff 

			

		if __name__ == '__main__':

			some_func()

* You can also change the email addresses that error messages are sent to:

		@try_then_alert(alert_recipients=['[email protected]', '[email protected]'])

		def some_func():

* and you can change the email subject lines using the parameters `error_subject` and `completion_subject`