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 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-5.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-5.0.0-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: notipydesktop-5.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-5.0.0.tar.gz
Algorithm Hash digest
SHA256 4eb43a2d20d9f8b0981c15e6811e08da011862df53c2821822497ba4fce5c091
MD5 72bf4e0a85f8026eac033e9a674ac0de
BLAKE2b-256 4be822cd2e9088ab75811e6870b223f530560e67aaf60da9894eeb4ea2aad864

See more details on using hashes here.

File details

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

File metadata

  • Download URL: NotipyDesktop-5.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-5.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ca5310da3fc7e2689b0ce24f10e38519de0901cf55fd34b3c3f29963e6659199
MD5 c754ea63cb78043f06ca3283a42ac7b7
BLAKE2b-256 c3f223a890ab1599a15d92e4baac51cab8d287c02a410445de2bfd4c3a513843

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