Skip to content

Michdo93/NotipyDesktop

Repository files navigation

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

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages