{ "info": { "author": "Zhun Hung", "author_email": "yongzhunhung@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "\n\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\n
\n

\n \n \"Logo\"\n \n\n

Toaster

\n\n

\n A simple python library that sends you a message on your preferred channel when your code finished running or encountered an error.\n
\n

\n

\n\n\n\n\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\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\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=, notification_channel='telegram')\n\n# for slack notification\nset_config(config_str=, 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\"Telegram\n\n##### - Slack Example:\n\"Slack\n\n\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\"Start \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\"Slack\n\n\n\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\n## License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n\n\n## Acknowledgements\n\n* Gal Shir for his cute toaster design [https://galshir.com/](https://galshir.com/)\n\n\n\n\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&logo=linkedin&colorB=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\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/zhunhung/toaster/", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "pytoaster", "package_url": "https://pypi.org/project/pytoaster/", "platform": "", "project_url": "https://pypi.org/project/pytoaster/", "project_urls": { "Homepage": "https://github.com/zhunhung/toaster/" }, "release_url": "https://pypi.org/project/pytoaster/0.0.7/", "requires_dist": null, "requires_python": ">=3.6", "summary": "Sends a telegram message to you when your code finish running", "version": "0.0.7" }, "last_serial": 5977574, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "1bebbf8f019d8b5c65938ffdab2f19a0", "sha256": "ca799757cfaa10210d57beb957c7828c239e3ac085e50beda215a8a8c6db8bc0" }, "downloads": -1, "filename": "pytoaster-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "1bebbf8f019d8b5c65938ffdab2f19a0", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 4879, "upload_time": "2019-09-24T16:17:00", "url": "https://files.pythonhosted.org/packages/2b/85/c1ec7669b6376cd8d50c3b7b6f1aeec3bdff8f68e8e31c5d62fed8055243/pytoaster-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "96b377eefe7f1610e54e69bb694a20ff", "sha256": "1d35f1860c2bd739f3fa21a780c0a76d6cb15199ffe26923dd2c926f4a2ca877" }, "downloads": -1, "filename": "pytoaster-0.0.1.tar.gz", "has_sig": false, "md5_digest": "96b377eefe7f1610e54e69bb694a20ff", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 4192, "upload_time": "2019-09-24T16:17:03", "url": "https://files.pythonhosted.org/packages/05/83/124f87db8768bbb86e93bccdc214c4ed1247e9e65b6fef5e8602ad6593c5/pytoaster-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "08f59681fbd6ec08d24df11fc11dfa6b", "sha256": "80ebb5680b1a9023f92ddcd8a5dfa25ef5a2c5b9ef01a55dcae27e2faf17117a" }, "downloads": -1, "filename": "pytoaster-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "08f59681fbd6ec08d24df11fc11dfa6b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 4890, "upload_time": "2019-09-24T16:24:08", "url": "https://files.pythonhosted.org/packages/0c/be/518d9097d3fb33c87aa438453c0423c7e2e241815ceae622effa4d72efad/pytoaster-0.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6c4d6db64eee8c100f32c570aa28d74e", "sha256": "e5d2a8a60befaceaffae9ce1105b1a2e53a43558d7f6aad355c0134fdeab5f12" }, "downloads": -1, "filename": "pytoaster-0.0.2.tar.gz", "has_sig": false, "md5_digest": "6c4d6db64eee8c100f32c570aa28d74e", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 4253, "upload_time": "2019-09-24T16:24:10", "url": "https://files.pythonhosted.org/packages/83/f7/a9bb764b05861897dc74e6cf672862864ccd4a5d0f95450ee681b622dfdf/pytoaster-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "47ecf1ff4615b73efd14c59a22e3ea9d", "sha256": "5a95e910e3dafd878340a2360cd534052700383fb9ac09a790331f3ab1082ad6" }, "downloads": -1, "filename": "pytoaster-0.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "47ecf1ff4615b73efd14c59a22e3ea9d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 5165, "upload_time": "2019-09-25T13:41:15", "url": "https://files.pythonhosted.org/packages/44/9d/722583abff6ced5f14be0841e545e7a584e0e6cb8dd4081e51893185a0a5/pytoaster-0.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9759d45e7a46e4b5c26917e7242edbc8", "sha256": "3b35e01c92b63ccb158d67008b429707e4a3bdf550561a328e72ecc46f98d12b" }, "downloads": -1, "filename": "pytoaster-0.0.3.tar.gz", "has_sig": false, "md5_digest": "9759d45e7a46e4b5c26917e7242edbc8", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 4517, "upload_time": "2019-09-25T13:41:17", "url": "https://files.pythonhosted.org/packages/3e/75/64e01c79c251471011b2ebed1d284af667b221c73c8803911f2c5620f28a/pytoaster-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "31a4ffed6c561b7d13f9603f33342168", "sha256": "dc98d0dc9137e0cbd902c7f2fc78883d358545554ce204f69edd90e6fb3d6b9a" }, "downloads": -1, "filename": "pytoaster-0.0.4-py3-none-any.whl", "has_sig": false, "md5_digest": "31a4ffed6c561b7d13f9603f33342168", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 5227, "upload_time": "2019-09-25T14:05:48", "url": "https://files.pythonhosted.org/packages/59/0f/cd4510a518ca74ef305e2804096d927753eda2cb0188810a2d9e46e0d8b7/pytoaster-0.0.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f439adaae402bf856fcc6f503f00ae96", "sha256": "becfff7aa11cea65aec45920534d137c6eeb4a4fe380927383119c94c2729160" }, "downloads": -1, "filename": "pytoaster-0.0.4.tar.gz", "has_sig": false, "md5_digest": "f439adaae402bf856fcc6f503f00ae96", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 4335, "upload_time": "2019-09-25T14:05:51", "url": "https://files.pythonhosted.org/packages/0e/2b/f76b4c8aa65912afd476811b705bba5f46cc933f520913e8ea2e83663f05/pytoaster-0.0.4.tar.gz" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "c2311d8371d9ee44d84d3bc81e49e585", "sha256": "57a86c404519554c9b64be892f5b809ed389d60b76616e0c55392f1533f4b839" }, "downloads": -1, "filename": "pytoaster-0.0.5-py3-none-any.whl", "has_sig": false, "md5_digest": "c2311d8371d9ee44d84d3bc81e49e585", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 5225, "upload_time": "2019-09-25T14:30:03", "url": "https://files.pythonhosted.org/packages/d0/bb/00b8f511de6caaade58800a1bf6d1d8736b520e3c07b374fde9f2799afde/pytoaster-0.0.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f13423324400a96dc4329ced3e468354", "sha256": "510c8a77bfa23dc1c848c2472308474be17bf8eadf1ceb45495a9e2013b88b20" }, "downloads": -1, "filename": "pytoaster-0.0.5.tar.gz", "has_sig": false, "md5_digest": "f13423324400a96dc4329ced3e468354", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 4331, "upload_time": "2019-09-25T14:30:09", "url": "https://files.pythonhosted.org/packages/92/e1/1526fae058b3e2af2194e3ec878dba4de3716cf5038c5b8d8ebe60b22a7b/pytoaster-0.0.5.tar.gz" } ], "0.0.6": [ { "comment_text": "", "digests": { "md5": "1c0889fbb19003d7692a39f3007e915d", "sha256": "b6cb3fbfc419b82cd7974b74354acf49386e213e6de0b6fe604e7dfa8a41d496" }, "downloads": -1, "filename": "pytoaster-0.0.6-py3-none-any.whl", "has_sig": false, "md5_digest": "1c0889fbb19003d7692a39f3007e915d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 5225, "upload_time": "2019-09-25T14:38:51", "url": "https://files.pythonhosted.org/packages/b6/9b/7557e183807c3fd0c538caf54177cd1d98ff40e1b7f1539819d34917754c/pytoaster-0.0.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d091aac87dff74e5e5fa1ef6e51e0a50", "sha256": "27bfadebd459aaf98eba458616679008599558b414017997e0711575359743c8" }, "downloads": -1, "filename": "pytoaster-0.0.6.tar.gz", "has_sig": false, "md5_digest": "d091aac87dff74e5e5fa1ef6e51e0a50", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 4327, "upload_time": "2019-09-25T14:38:53", "url": "https://files.pythonhosted.org/packages/a9/b4/33a1efc9ffc8eff10b3a57f44bc2597c99e80e378f58d1d188928a1b55e1/pytoaster-0.0.6.tar.gz" } ], "0.0.7": [ { "comment_text": "", "digests": { "md5": "fc3b5350606a427ab619d284c158cae7", "sha256": "f6736cbab7f38d06d56ab6f2bd863f67ba2487927ef32a11a20e77ccfca05fba" }, "downloads": -1, "filename": "pytoaster-0.0.7-py3-none-any.whl", "has_sig": false, "md5_digest": "fc3b5350606a427ab619d284c158cae7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 5919, "upload_time": "2019-10-15T14:04:01", "url": "https://files.pythonhosted.org/packages/9d/db/6a4d5b61b3befb360d52b80b0adb80551a6d444acbe6fa97e1319594b699/pytoaster-0.0.7-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "466ab13b8e700cde5ddc59b773f78ec8", "sha256": "43b0184859d18f608700fd84e4765186a5d44d0cec230472d0550db54760fdf1" }, "downloads": -1, "filename": "pytoaster-0.0.7.tar.gz", "has_sig": false, "md5_digest": "466ab13b8e700cde5ddc59b773f78ec8", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 5005, "upload_time": "2019-10-15T14:04:04", "url": "https://files.pythonhosted.org/packages/b2/3a/cf1197453dab6b4287ea542c7732bd65755098864d6ec26c883cdc651dd4/pytoaster-0.0.7.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "fc3b5350606a427ab619d284c158cae7", "sha256": "f6736cbab7f38d06d56ab6f2bd863f67ba2487927ef32a11a20e77ccfca05fba" }, "downloads": -1, "filename": "pytoaster-0.0.7-py3-none-any.whl", "has_sig": false, "md5_digest": "fc3b5350606a427ab619d284c158cae7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 5919, "upload_time": "2019-10-15T14:04:01", "url": "https://files.pythonhosted.org/packages/9d/db/6a4d5b61b3befb360d52b80b0adb80551a6d444acbe6fa97e1319594b699/pytoaster-0.0.7-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "466ab13b8e700cde5ddc59b773f78ec8", "sha256": "43b0184859d18f608700fd84e4765186a5d44d0cec230472d0550db54760fdf1" }, "downloads": -1, "filename": "pytoaster-0.0.7.tar.gz", "has_sig": false, "md5_digest": "466ab13b8e700cde5ddc59b773f78ec8", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 5005, "upload_time": "2019-10-15T14:04:04", "url": "https://files.pythonhosted.org/packages/b2/3a/cf1197453dab6b4287ea542c7732bd65755098864d6ec26c883cdc651dd4/pytoaster-0.0.7.tar.gz" } ] }