https://github.com/zhunhung/toaster
Toaster is a simple python library that sends you a message when your code finishes
https://github.com/zhunhung/toaster
deep-learning machine-learning python telegram
Last synced: 3 months ago
JSON representation
Toaster is a simple python library that sends you a message when your code finishes
- Host: GitHub
- URL: https://github.com/zhunhung/toaster
- Owner: zhunhung
- License: mit
- Created: 2019-09-23T13:35:46.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-10-28T03:29:57.000Z (over 6 years ago)
- Last Synced: 2025-12-15T11:42:54.478Z (6 months ago)
- Topics: deep-learning, machine-learning, python, telegram
- Language: Python
- Homepage:
- Size: 117 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
Toaster
A simple python library that sends you a message on your preferred channel when your code finished running or encountered an error.
## Table of Contents
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Usage](#usage)
* [Frequently Asked Questions](#frequently-asked-questions)
* [Contributing](#contributing)
* [License](#license)
* [Acknowledgements](#acknowledgements)
## Getting Started
To set up Toaster, simply follow the installation and usage example.
### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
* Preferred notification channel (Telegram account/Slack Webhook URL)
* Python 3
### Installation
1. Install via pip
```sh
pip install pytoaster
```
## Usage
#### Step 1. Import methods and configure toaster using `set_config()`.
```python
from toaster import telegram_toast, slack_toast, set_config
# for telegram notification
set_config(config_str=, notification_channel='telegram')
# for slack notification
set_config(config_str=, notification_channel='slack')
```
*Note*: You'll only have to do this once, it'll then be saved to `config.json` in toaster's installation path.
#### Step 2. Add `@(channeltype)_toast` above functions that you want to be notified upon completion.
```python
# telegram example
@telegram_toast
def test_func(a,b):
time.sleep(5)
return 'Return {} and {}'.format(str(a),str(b))
# slack example
@slack_toast
def test_func(a,b):
time.sleep(5)
return 'Return {} and {}'.format(str(a),str(b))
```
#### Step 3. You'll be notified by according to your preferred channel when your code finishes executing.
##### - Telegram Example: Notification by [@FreshToasterBot](http://t.me/freshtoasterbot)
##### - Slack Example:
## Frequently Asked Questions
#### 1. How do I find my Telegram ID?
Get your telegram ID from [@FreshToasterBot](http://t.me/freshtoasterbot) on Telegram
#### 2. How do I setup my Slack Webhook?
Follow the [official instructions](https://slack.com/intl/en-sg/help/articles/115005265063-incoming-webhooks-for-slack) from Slack
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Acknowledgements
* Gal Shir for his cute toaster design [https://galshir.com/](https://galshir.com/)
* Yuval for his contribution to integrating slack [https://github.com/GuitaristForEver](https://github.com/GuitaristForEver)
[contributors-shield]: https://img.shields.io/github/contributors/zhunhung/toaster.svg?style=flat-square
[contributors-url]: https://github.com/zhunhung/toaster/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/zhunhung/toaster.svg?style=flat-square
[forks-url]: https://github.com/zhunhung/toaster/network/members
[stars-shield]: https://img.shields.io/github/stars/zhunhung/toaster.svg?style=flat-square
[stars-url]: https://github.com/zhunhung/toaster/stargazers
[issues-shield]: https://img.shields.io/github/issues/zhunhung/toaster.svg?style=flat-square
[issues-url]: https://github.com/zhunhung/toaster/issues
[license-shield]: https://img.shields.io/github/license/zhunhung/toaster.svg?style=flat-square
[license-url]: https://github.com/zhunhung/toaster/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/in/zhunhung/
[product-screenshot]: https://github.com/zhunhung/toaster/blob/master/images/toaster_image.jpg