Herald
Programmatically send notifications!
About
Have you ever been in a situation where you’ve been simply twiddling your thumbs, waiting for your program to finish compiling/running? Are you into Deep Learning and need a way to notify yourself when your program crashes or is done learning to do the impossible?
Then Herald is for you!
With a simple, extensible and pythonic interface, you can get setup with a programmatic way of notifying yourself and/or your teammates about different events in your code.
The following platforms are currently supported:
GMail
Twilio
Need to use it with a custom platform? You can easily write your own notifier and plug it in to handle that, making Herald infinitely extensible.
Installation
The easy pip install herald-notify.
Usage
The primary way to use Herald is like a context manager. E.g.
import herald
from herald import notifiers
# Send yourself a mail in Gmail to notify you
# Assumes your Gmail tokens have been set up properly
notifier = notifiers.GmailNotifier()
with Herald(notifier, message="Model Trained!"):
# super long running process
train_model()
...
You should get an email in your registered Gmail account at the end of the program.
You can also specify notifications at arbitrary points via the notifier call:
import herald
from herald import notifiers
notifier = notifiers.TerminalNotifier("Whoop de doo!")
notifier.notify("A new custom message")
# Send the original message from the constructor
notifier.notify()
Contributing
If you find bugs, please feel free to submit an Issue, or even better, a Pull Request!
Development
To set up your dev environment, perform the following steps: - Clone Herald - Inside the root directory, run pipenv shell to open a shell. - Finally run pipenv install to install all the dependencies.
At this point, you should be good to go!
Testing
WIP
Metadata
Release files for herald-notify 1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| herald-notify-1.0.1.tar.gz | 4.9 kB | Without provenance | Details for herald-notify-1.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| herald_notify-1.0.1-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details for herald_notify-1.0.1-py2.py3-none-any.whl |
Total release size: 13.0 kB
Release files / herald-notify-1.0.1.tar.gz
| Download URL | herald-notify-1.0.1.tar.gz |
|---|---|
| Size | 4.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6c70306325a3f6ec617095c22d6ac85e69a0dca9969c6ad175edb2921cddfbe0
|
|
BLAKE2b-256 checksum How to use checksums |
72b11b2a9894ca159478d7e274d2a279a1da507d0a2ae92dd85dcd79e4cf5ec7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / herald_notify-1.0.1-py2.py3-none-any.whl
| Download URL | herald_notify-1.0.1-py2.py3-none-any.whl |
|---|---|
| Size | 8.1 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
dcf7363240a5056bbbabdc8d622e2e9d6dbd530fac9b93ad1afe6c5835db8308
|
|
BLAKE2b-256 checksum How to use checksums |
af5246074601d4bd1f30a3bdd8a30cc2725511e448a7d3c753dc661a3ee25964
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for herald-notify 1.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.