Skip to main content

Display native customizable Mac OS dialogs and notifications with ease

Project description

Notipy

Python packge to display native customizable Mac OS dialogs and notifications with ease

Version PyPI - Downloads MIT Buy Me A Coffee

Example

Example

Example

Example

Example

Check out the code for these examples in examples/dialogs/readme_examples.py.

🚀 Features

  • Display native dialogs
    • Add buttons
    • Text input (including hidden/password fields)
    • Callbacks (get button pressed and text enterd)
    • Customize icons
  • Display native notifications
    • Customize title, subtitle, and information text
    • Cusomize icon
    • Schedule a notification (using delay)
    • Fallback to AppleScript notifications if PyObjC doesn't work
    • Callbacks (button pressed, reply text, ...) (please see this answer)
  • Display choice prompts
  • Display color select prompts

🛠 Quick start

Install

pip3 install notipy-osx
pip3 install pyobjc

Display a dialog

from notipy_osx import dialog_prompt

dialog_prompt(text='This is a basic dialog')

Show a notification

from notipy_osx import notify

notify(title='New Notifiation')
# if pyobjc notifications do not work, notifications will still be shown with osascript

If notifications do not work, ensure that you allow notifications from both Python and Script Editor (AppleScript):

Example

More

  • Choice prompt (choose from a list of items)
  • Display a color picker

Next steps

  • View the guide for a full understanding of all the parameters for the display_dialog and notify functions
  • See the examples
  • View (and star) the GitHub repository

📕 View the rest of the documentation here

😱 Issues and limitations

  • No callbacks for notifications (please see this answer)
  • PyObjC notifications do not work on all Mac OS devices (possible issue), although a fallback has been set
  • Only for Mac OS

♥️ Support

If you liked this project, consider supporting by

  • ⭐️ Starring the repository
  • 🎒 Checking out my other projects
  • ☕️ Buying me coffee

📜 License

  • MIT
  • The icon Terminal.icns in examples/icons is a copy of Terminal.app's icon, which is copyrighted by Apple.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

notipy_osx-0.0.8.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

notipy_osx-0.0.8-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file notipy_osx-0.0.8.tar.gz.

File metadata

  • Download URL: notipy_osx-0.0.8.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.6

File hashes

Hashes for notipy_osx-0.0.8.tar.gz
Algorithm Hash digest
SHA256 a9c19e8e34ba8d41360e2402aa693d41e1ca50abd6bac2f5cf9e6e67575a71e4
MD5 283ca33c246a62aa381ba0ab23f56a72
BLAKE2b-256 43115206d47de4cb325eb0a8f1b07883b1960cd8b222b476f826befac8346d91

See more details on using hashes here.

File details

Details for the file notipy_osx-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: notipy_osx-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.6

File hashes

Hashes for notipy_osx-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 23a4a274bdd98e8cfbea956ebda7b06f8e2a838ab4a6310fb4a329280b23af80
MD5 9f762666e3436be26b04991f9929b7b9
BLAKE2b-256 e36b588e71b1a6881d9b047926b3bf8124b454e92f4883c31b97d5c68ece9ab0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page