GitHub Desktop Notifier

GitHub Desktop Notifier is an easy-to-use Python script that sends you a desktop notification whenever you receive a notification on GitHub. Stay updated with your GitHub activities without constantly checking your email or GitHub dashboard. Get instant desktop notifications for new issues, pull requests, comments, and more.

Features

• Real-time Notifications: Receive instant desktop alerts for new GitHub activities.
• Interactive Actions: Open notifications in your browser or mark them as read directly from the notification popup.
• Supports All Notification Types: Get notifications for issues, pull requests, comments, and more.
• Easy to Use: Simply run the script and authenticate with GitHub via browser to start receiving notifications, no need to create GitHub API tokens.

Preview

Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

• Python 3: The script is written in Python and requires Python 3 to run.
• libnotify-bin: Enables desktop notifications on Linux systems.
• GitHub CLI (gh): Allows the script to interact with GitHub.
• Pipx: Used to install Python packages globally.

Installation

1. Install required packages on Debian/Ubuntu:

sudo apt update
sudo apt install -y python3 libnotify-bin gh pipx

2. Install GitHub Desktop Notifier:

pipx install github-desktop-notifier

Usage

Using GitHub Desktop Notifier is simple. Just run the following command in your terminal:

github-notifier

Command-Line Options

You can customize the behavior of the notifier using the following command-line options:

$ github-notifier --help
usage: github-notifier [-h] [--refresh-rate REFRESH_RATE] [--timeout TIMEOUT]
                       [--urgency {low,normal,critical}] [--icon-path ICON_PATH]

GitHub Desktop Notifier

options:
  -h, --help            show this help message and exit
  --refresh-rate REFRESH_RATE
                        Interval in seconds to check for new notifications (default:
                        10)
  --timeout TIMEOUT     Timeout in seconds for the notification (default: 15).
                        Ignored if urgency is 'critical'.
  --urgency {low,normal,critical}
                        Urgency level of the notification: 'low', 'normal', or
                        'critical' (default: critical)
  --icon-path ICON_PATH
                        Path to the icon to display in the notification (default:
                        /path/to/github-logo.png)

• If you haven't authenticated with gh (GitHub CLI), you'll be prompted to do so. Follow the instructions to authenticate via your web browser.
• After authenticating, the script will run in the background and send you desktop notifications for new GitHub activities.

That's it! You'll now receive desktop notifications for new GitHub activities. Click on the notification buttons to open the notification in your browser or mark it as read.

License

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