Skip to main content

A simple Python notification library using libnotify.

Project description

NotipyDesktop

NotipyDesktop is a simple Python library for sending desktop notifications using libnotify.

Features

  • Send desktop notifications with a title and message.
  • Easy-to-use API with just one function.
  • Uses PyGObject to interact with GNOME notifications.

Installation

Install the library via pip:

pip install NotipyDesktop

Usage

Here's an example of how to use notifier:

from NotipyDesktop import notify

# Send a notification
notify("MyApp", "Test Notification", "This is a test message.")

CLI Usage

local path

You can also use the library as a command-line tool. Run the following command to send a notification:

python3 NotipyDesktop.py MyApp "Test Notification" "This is a test message."

sytem wide

You can make the program system wide executable with:

chmod +x /path/to/NotipyDesktop/NotipyDesktop.py

After that you have to add the path to $PATH:

export PATH=$PATH:/path/to/NotipyDesktop

Then you can run:

NotipyDesktop.py MyApp "Test Notification" "This is a test message."

Requirements

  • Python 3.6 or higher
  • GNOME Desktop Environment (or a compatible Linux desktop environment)
  • libnotify installed on your system

Install the required Python dependencies:

pip install PyGObject

For most Linux distributions, you can install libnotify with your package manager. Example for Ubuntu/Debian:

sudo apt install libnotify-bin

Development

To set up the project locally for development:

  1. Clone the repository:

    git clone https://github.com/Michdo93/NotipyDesktop.git
    cd NotipyDesktop
    
  2. Install dependencies:

    pip install -r requirements.txt
    
  3. Run the tests or use the CLI to validate functionality.


Contributing

Contributions are welcome! If you find a bug or have a feature request, feel free to open an issue or submit a pull request.


License

This project is licensed under the MIT License. See the LICENSE file for details.


Acknowledgments

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

notipydesktop-3.0.0.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

NotipyDesktop-3.0.0-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

Details for the file notipydesktop-3.0.0.tar.gz.

File metadata

  • Download URL: notipydesktop-3.0.0.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.0 CPython/3.8.10

File hashes

Hashes for notipydesktop-3.0.0.tar.gz
Algorithm Hash digest
SHA256 68d9f976ca66012308cd315d3590c73858771273687a91e43eec576a84c03c66
MD5 28f9e148589770f6fa1ac8b8b1245aec
BLAKE2b-256 4197b157d5e845bb593efc384addd80372ad7e90cf718388948cee8470aa5f6f

See more details on using hashes here.

File details

Details for the file NotipyDesktop-3.0.0-py3-none-any.whl.

File metadata

  • Download URL: NotipyDesktop-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 3.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.0 CPython/3.8.10

File hashes

Hashes for NotipyDesktop-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 75718c6ef7c52061c3ebfca47fe55bf9a19cd71902fd4a54b58f7067f75a7bce
MD5 5f8c714107ff1f101def8896808bcf50
BLAKE2b-256 26bc532e9f5b7c1ec1bef6fee83be161aea90206bb403705d9fb776f514567d7

See more details on using hashes here.

Supported by

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