{"id":34035852,"url":"https://github.com/zhunhung/toaster","last_synced_at":"2026-04-06T09:01:34.294Z","repository":{"id":57457859,"uuid":"210363915","full_name":"zhunhung/toaster","owner":"zhunhung","description":"Toaster is a simple python library that sends you a message when your code finishes","archived":false,"fork":false,"pushed_at":"2019-10-28T03:29:57.000Z","size":120,"stargazers_count":5,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-12-15T11:42:54.478Z","etag":null,"topics":["deep-learning","machine-learning","python","telegram"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zhunhung.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-23T13:35:46.000Z","updated_at":"2022-09-15T00:05:34.000Z","dependencies_parsed_at":"2022-09-07T03:41:38.175Z","dependency_job_id":null,"html_url":"https://github.com/zhunhung/toaster","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/zhunhung/toaster","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhunhung%2Ftoaster","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhunhung%2Ftoaster/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhunhung%2Ftoaster/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhunhung%2Ftoaster/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zhunhung","download_url":"https://codeload.github.com/zhunhung/toaster/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhunhung%2Ftoaster/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31466228,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-06T08:36:52.050Z","status":"ssl_error","status_checked_at":"2026-04-06T08:36:51.267Z","response_time":112,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["deep-learning","machine-learning","python","telegram"],"created_at":"2025-12-13T20:04:58.404Z","updated_at":"2026-04-06T09:01:34.278Z","avatar_url":"https://github.com/zhunhung.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- PROJECT SHIELDS --\u003e\n\u003c!--\n*** I'm using markdown \"reference style\" links for readability.\n*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).\n*** See the bottom of this document for the declaration of the reference variables\n*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.\n*** https://www.markdownguide.org/basic-syntax/#reference-style-links\n--\u003e\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n[![LinkedIn][linkedin-shield]][linkedin-url]\n\n\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/zhunhung/toaster\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/zhunhung/toaster/master/images/toaster_image.jpg\" alt=\"Logo\" width=\"180\" height=\"180\"\u003e\n  \u003c/a\u003e\n\n  \u003ch3 align=\"center\"\u003eToaster\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    A simple python library that sends you a message on your preferred channel when your code finished running or encountered an error.\n    \u003cbr /\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n## Table of Contents\n\n\n* [Getting Started](#getting-started)\n  * [Prerequisites](#prerequisites)\n  * [Installation](#installation)\n* [Usage](#usage)\n* [Frequently Asked Questions](#frequently-asked-questions)\n* [Contributing](#contributing)\n* [License](#license)\n* [Acknowledgements](#acknowledgements)\n\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\nTo set up Toaster, simply follow the installation and usage example.\n\n### Prerequisites\n\nThis is an example of how to list things you need to use the software and how to install them.\n* Preferred notification channel (Telegram account/Slack Webhook URL)\n* Python 3\n\n### Installation\n\n1. Install via pip\n```sh\npip install pytoaster\n```\n\n\u003c!-- USAGE EXAMPLES --\u003e\n## Usage\n\n#### Step 1. Import methods and configure toaster using `set_config()`.\n```python\nfrom toaster import telegram_toast, slack_toast, set_config\n\n# for telegram notification\nset_config(config_str=\u003cyour_telegram_id\u003e, notification_channel='telegram')\n\n# for slack notification\nset_config(config_str=\u003cincoming_webhook\u003e, notification_channel='slack')\n```  \n*Note*: You'll only have to do this once, it'll then be saved to `config.json` in toaster's installation path.\n\n#### Step 2. Add `@(channeltype)_toast` above functions that you want to be notified upon completion.\n```python\n# telegram example\n@telegram_toast\ndef test_func(a,b):\n    time.sleep(5)\n    return 'Return {} and {}'.format(str(a),str(b))\n\n# slack example\n@slack_toast\ndef test_func(a,b):\n    time.sleep(5)\n    return 'Return {} and {}'.format(str(a),str(b))\n```\n\n#### Step 3. You'll be notified by according to your preferred channel when your code finishes executing.  \n##### - Telegram Example: Notification by [@FreshToasterBot](http://t.me/freshtoasterbot)\n\u003cimg src=\"https://raw.githubusercontent.com/zhunhung/toaster/master/images/sample_response.jpg\" alt=\"Telegram Sample Response\" width=\"380\" height=\"100\"\u003e\n\n##### - Slack Example:\n\u003cimg src=\"https://raw.githubusercontent.com/zhunhung/toaster/master/images/slack_sample_response.jpg\" alt=\"Slack Sample Response\" width=\"380\" height=\"100\"\u003e\n\n\u003c!-- FAQ --\u003e\n## Frequently Asked Questions\n\n#### 1. How do I find my Telegram ID?  \nGet your telegram ID from [@FreshToasterBot](http://t.me/freshtoasterbot) on Telegram  \n\u003cimg src=\"https://raw.githubusercontent.com/zhunhung/toaster/master/images/start_convo.jpg\" alt=\"Start Convo\" width=\"350\" height=\"100\"\u003e  \n\n#### 2. How do I setup my Slack Webhook?  \nFollow the [official instructions](https://slack.com/intl/en-sg/help/articles/115005265063-incoming-webhooks-for-slack) from Slack  \n\u003cimg src=\"https://raw.githubusercontent.com/zhunhung/toaster/master/images/webhook_setup.jpg\" alt=\"Slack Instructions\" width=\"350\" height=\"200\"\u003e\n\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nContributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n\n\u003c!-- ACKNOWLEDGEMENTS --\u003e\n## Acknowledgements\n\n* Gal Shir for his cute toaster design [https://galshir.com/](https://galshir.com/)  \n* Yuval for his contribution to integrating slack [https://github.com/GuitaristForEver](https://github.com/GuitaristForEver)  \n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n[contributors-shield]: https://img.shields.io/github/contributors/zhunhung/toaster.svg?style=flat-square\n[contributors-url]: https://github.com/zhunhung/toaster/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/zhunhung/toaster.svg?style=flat-square\n[forks-url]: https://github.com/zhunhung/toaster/network/members\n[stars-shield]: https://img.shields.io/github/stars/zhunhung/toaster.svg?style=flat-square\n[stars-url]: https://github.com/zhunhung/toaster/stargazers\n[issues-shield]: https://img.shields.io/github/issues/zhunhung/toaster.svg?style=flat-square\n[issues-url]: https://github.com/zhunhung/toaster/issues\n[license-shield]: https://img.shields.io/github/license/zhunhung/toaster.svg?style=flat-square\n[license-url]: https://github.com/zhunhung/toaster/blob/master/LICENSE.txt\n[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square\u0026logo=linkedin\u0026colorB=555\n[linkedin-url]: https://www.linkedin.com/in/zhunhung/\n[product-screenshot]: https://github.com/zhunhung/toaster/blob/master/images/toaster_image.jpg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhunhung%2Ftoaster","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzhunhung%2Ftoaster","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhunhung%2Ftoaster/lists"}