Readme
You can read the docs on this Git's Wiki, or here
No dependencies are required other than loguru & jeepney (Only for linux/DBUS).
pip install notify-py
Send Simple Notification
from notifypy import Notify
notification = Notify()
notification.title = "Cool Title"
notification.message = "Even cooler message."
notification.send()
Send Notification With Icon
from notifypy import Notify
notification = Notify()
notification.title = "Cool Title"
notification.message = "Even cooler message."
notification.icon = "path/to/icon.png"
notification.send()
Send Notification With Sound
from notifypy import Notify
notification = Notify()
notification.title = "Cool Title"
notification.message = "Even cooler message."
notification.audio = "path/to/audio/file.wav"
notification.send()
Sending Notifications without blocking
from notifypy import Notify
notification = Notify()
notification.send(block=False)
Sending with Default Notification Titles/Messages/Icons
from notifypy import Notify
notification = Notify(
default_notification_title="Function Message",
default_application_name="Great Application",
default_notification_icon="path/to/icon.png",
default_notification_audio="path/to/sound.wav"
)
def your_function():
# stuff happening here.
notification.message = "Function Result"
notification.send()
A CLI is available when you install notify-py
notifypy --title --message --applicationName --iconPath --soundPath
You may need to add python3 -m to the beginning.
As it stands (May 18, 2020), this is simply a notification service. There is no support for embedding custom actions (buttons, dialogs) regardless of platform. Other then telling you if the shell command was sent, there is also no confirmation on user action on the notification.
macOS does not support custom icons on the fly.. You will need to bundle a customized version of the notifier embedded with your custom icon.
https://github.com/go-toast/toast - Ported their Windows 10 toast notification to Python.
https://notificationsounds.com/notification-sounds/done-for-you-612 example_notification_sound.wav
Contributions are welcome!
Please base your changes on the latest development branch and open a PR to that branch. PR will not be accepted to the master branch. Tests are ran against all platforms.
poetry installpoetry run pytest tests/*poetry run pylint --errors-only notifypy/poetry run black notifypydev branch.FAQs
Cross-platform desktop notification library for Python
We found that notify-py demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket CEO Feross Aboukhadijeh joins a16z partners to discuss how modern, sophisticated supply chain attacks require AI-driven defenses and explore the challenges and solutions in leveraging AI for threat detection early in the development life cycle.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.