{ "info": { "author": "Varun Agrawal", "author_email": "varunagrawal@gatech.edu", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: MacOS", "Operating System :: Microsoft :: Windows", "Operating System :: POSIX", "Operating System :: Unix", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "Herald\n======\n\nProgrammatically send notifications!\n\nAbout\n-----\n\nHave you ever been in a situation where you've been simply twiddling\nyour thumbs, waiting for your program to finish compiling/running? Are\nyou into Deep Learning and need a way to notify yourself when your\nprogram crashes or is done learning to do the impossible?\n\nThen *Herald* is for you!\n\nWith a simple, extensible and pythonic interface, you can get setup with\na programmatic way of notifying yourself and/or your teammates about\ndifferent events in your code.\n\nThe following platforms are currently supported:\n\n- GMail\n- Twilio\n\nNeed to use it with a custom platform? You can easily write your own\n``notifier`` and plug it in to handle that, making *Herald* infinitely\nextensible.\n\nInstallation\n------------\n\nThe easy ``pip install herald-notify``.\n\nUsage\n-----\n\nThe primary way to use *Herald* is like a context manager. E.g.\n\n.. code:: python\n\n import herald\n from herald import notifiers\n\n # Send yourself a mail in Gmail to notify you\n # Assumes your Gmail tokens have been set up properly\n notifier = notifiers.GmailNotifier()\n\n with Herald(notifier, message=\"Model Trained!\"):\n # super long running process\n train_model()\n ...\n\nYou should get an email in your registered Gmail account at the end of\nthe program.\n\nYou can also specify notifications at arbitrary points via the\n``notifier`` call:\n\n.. code:: python\n\n import herald\n from herald import notifiers\n\n notifier = notifiers.TerminalNotifier(\"Whoop de doo!\")\n\n notifier.notify(\"A new custom message\")\n\n # Send the original message from the constructor\n notifier.notify()\n\nContributing\n------------\n\nIf you find bugs, please feel free to submit an Issue, or even better, a\nPull Request!\n\nDevelopment\n~~~~~~~~~~~\n\nTo set up your dev environment, perform the following steps: - Clone\n*Herald* - Inside the root directory, run ``pipenv shell`` to open a\nshell. - Finally run ``pipenv install`` to install all the dependencies.\n\nAt this point, you should be good to go!\n\nTesting\n~~~~~~~\n\nWIP\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/varunagrawal/herald", "keywords": "herald,notification,notify,extensible", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "herald-notify", "package_url": "https://pypi.org/project/herald-notify/", "platform": "any", "project_url": "https://pypi.org/project/herald-notify/", "project_urls": { "Homepage": "https://github.com/varunagrawal/herald" }, "release_url": "https://pypi.org/project/herald-notify/1.0.1/", "requires_dist": [ "google-api-python-client", "httplib2", "oauth2client", "twilio" ], "requires_python": "", "summary": "Programmable, extensible and easy to use notification system", "version": "1.0.1" }, "last_serial": 3345011, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "db56a474a546a4ef7798e221c5160bf2", "sha256": "a4fb7eff164c4c7fa748bcc481d0e08d23dbd8962ab42469fbdf3d7141af215e" }, "downloads": -1, "filename": "herald_notify-1.0.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "db56a474a546a4ef7798e221c5160bf2", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8111, "upload_time": "2017-11-19T02:32:34", "url": "https://files.pythonhosted.org/packages/b6/0f/945d4bda5e6348ee220f2d8deaa344479d1957de321834d8fc5da02d685b/herald_notify-1.0.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "241c929092b2cc0f25a0059ca891cfdb", "sha256": "18d5b77318af73b8a04236b2590507affccdead25a415413d0215c60d6abe572" }, "downloads": -1, "filename": "herald-notify-1.0.0.tar.gz", "has_sig": false, "md5_digest": "241c929092b2cc0f25a0059ca891cfdb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4905, "upload_time": "2017-11-19T02:32:35", "url": "https://files.pythonhosted.org/packages/6e/05/3bfff67faff9a0b0bd74c009354f07596b051fe467cc068b232560748db9/herald-notify-1.0.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "f7ad37a422b3e7e1e392d426c3d9b6cc", "sha256": "dcf7363240a5056bbbabdc8d622e2e9d6dbd530fac9b93ad1afe6c5835db8308" }, "downloads": -1, "filename": "herald_notify-1.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "f7ad37a422b3e7e1e392d426c3d9b6cc", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8114, "upload_time": "2017-11-19T02:34:11", "url": "https://files.pythonhosted.org/packages/af/52/46074601d4bd1f30a3bdd8a30cc2725511e448a7d3c753dc661a3ee25964/herald_notify-1.0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "954c9cb78822a56618032faf37d0ad8f", "sha256": "6c70306325a3f6ec617095c22d6ac85e69a0dca9969c6ad175edb2921cddfbe0" }, "downloads": -1, "filename": "herald-notify-1.0.1.tar.gz", "has_sig": false, "md5_digest": "954c9cb78822a56618032faf37d0ad8f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4906, "upload_time": "2017-11-19T02:34:12", "url": "https://files.pythonhosted.org/packages/72/b1/1b2a9894ca159478d7e274d2a279a1da507d0a2ae92dd85dcd79e4cf5ec7/herald-notify-1.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "f7ad37a422b3e7e1e392d426c3d9b6cc", "sha256": "dcf7363240a5056bbbabdc8d622e2e9d6dbd530fac9b93ad1afe6c5835db8308" }, "downloads": -1, "filename": "herald_notify-1.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "f7ad37a422b3e7e1e392d426c3d9b6cc", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8114, "upload_time": "2017-11-19T02:34:11", "url": "https://files.pythonhosted.org/packages/af/52/46074601d4bd1f30a3bdd8a30cc2725511e448a7d3c753dc661a3ee25964/herald_notify-1.0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "954c9cb78822a56618032faf37d0ad8f", "sha256": "6c70306325a3f6ec617095c22d6ac85e69a0dca9969c6ad175edb2921cddfbe0" }, "downloads": -1, "filename": "herald-notify-1.0.1.tar.gz", "has_sig": false, "md5_digest": "954c9cb78822a56618032faf37d0ad8f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4906, "upload_time": "2017-11-19T02:34:12", "url": "https://files.pythonhosted.org/packages/72/b1/1b2a9894ca159478d7e274d2a279a1da507d0a2ae92dd85dcd79e4cf5ec7/herald-notify-1.0.1.tar.gz" } ] }