# GitHub Desktop Notifier
[](LICENSE)
[](https://github.com/bytexenon/Github-Desktop-Notifier/stargazers)
**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:**
```bash
sudo apt update
sudo apt install -y python3 libnotify-bin gh pipx
```
2. **Install GitHub Desktop Notifier:**
```bash
pipx install github-desktop-notifier
```
### Usage
Using GitHub Desktop Notifier is simple. Just run the following command in your terminal:
```bash
github-notifier
```
### Command-Line Options
You can customize the behavior of the notifier using the following command-line options:
```console
$ 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](https://github.com/bytexenon/Github-Desktop-Notifier/blob/main/LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/bytexenon/Github-Desktop-Notifier",
"name": "github-desktop-notifier",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "github desktop notifier linux notifications dunstify gh",
"author": "bytexenon",
"author_email": "ddavi142@asu.edu",
"download_url": "https://files.pythonhosted.org/packages/31/a2/ba69b5a06f89b4b0782ffcee248b6121cbec6760978b9c1698195c1239c9/github_desktop_notifier-1.0.2.tar.gz",
"platform": null,
"description": "# GitHub Desktop Notifier\n\n[](LICENSE)\n[](https://github.com/bytexenon/Github-Desktop-Notifier/stargazers)\n\n**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.\n\n## Features\n\n- **Real-time Notifications**: Receive instant desktop alerts for new GitHub activities.\n- **Interactive Actions**: Open notifications in your browser or mark them as read directly from the notification popup.\n- **Supports All Notification Types**: Get notifications for issues, pull requests, comments, and more.\n- **Easy to Use**: Simply run the script and authenticate with GitHub via browser to start receiving notifications, no need to create GitHub API tokens.\n\n## Preview\n\n\n\n## Getting Started\n\n### Prerequisites\n\nBefore you begin, ensure you have the following installed:\n\n- **Python 3**: The script is written in Python and requires Python 3 to run.\n- **libnotify-bin**: Enables desktop notifications on Linux systems.\n- **GitHub CLI (`gh`)**: Allows the script to interact with GitHub.\n- **Pipx**: Used to install Python packages globally.\n\n### Installation\n\n1. **Install required packages on Debian/Ubuntu:**\n\n```bash\nsudo apt update\nsudo apt install -y python3 libnotify-bin gh pipx\n```\n\n2. **Install GitHub Desktop Notifier:**\n\n```bash\npipx install github-desktop-notifier\n```\n\n### Usage\n\nUsing GitHub Desktop Notifier is simple. Just run the following command in your terminal:\n\n```bash\ngithub-notifier\n```\n\n### Command-Line Options\n\nYou can customize the behavior of the notifier using the following command-line options:\n\n```console\n$ github-notifier --help\nusage: github-notifier [-h] [--refresh-rate REFRESH_RATE] [--timeout TIMEOUT]\n [--urgency {low,normal,critical}] [--icon-path ICON_PATH]\n\nGitHub Desktop Notifier\n\noptions:\n -h, --help show this help message and exit\n --refresh-rate REFRESH_RATE\n Interval in seconds to check for new notifications (default:\n 10)\n --timeout TIMEOUT Timeout in seconds for the notification (default: 15).\n Ignored if urgency is 'critical'.\n --urgency {low,normal,critical}\n Urgency level of the notification: 'low', 'normal', or\n 'critical' (default: critical)\n --icon-path ICON_PATH\n Path to the icon to display in the notification (default:\n /path/to/github-logo.png)\n```\n\n- 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.\n- After authenticating, the script will run in the background and send you desktop notifications for new GitHub activities.\n\n**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.\n\n## License\n\nThis project is licensed under the **MIT License** - see the [LICENSE](https://github.com/bytexenon/Github-Desktop-Notifier/blob/main/LICENSE) file for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Receive instant GitHub notifications on your Linux desktop",
"version": "1.0.2",
"project_urls": {
"Changelog": "https://github.com/bytexenon/Github-Desktop-Notifier/releases",
"Documentation": "https://github.com/bytexenon/Github-Desktop-Notifier",
"Homepage": "https://github.com/bytexenon/Github-Desktop-Notifier",
"Source": "https://github.com/bytexenon/Github-Desktop-Notifier",
"Tracker": "https://github.com/bytexenon/Github-Desktop-Notifier/issues"
},
"split_keywords": [
"github",
"desktop",
"notifier",
"linux",
"notifications",
"dunstify",
"gh"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a8942f1e80a5dc66839fb3951401bc9d674e9165ebf1e8a1e1909e29d2a94880",
"md5": "a82114474b657086b132ad5e2b4b52b5",
"sha256": "d5c4d02a3648baa7b57c17446581fdbc7c8938a440a4bc8ade7842da0f202525"
},
"downloads": -1,
"filename": "github_desktop_notifier-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a82114474b657086b132ad5e2b4b52b5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 7592,
"upload_time": "2024-11-15T13:00:33",
"upload_time_iso_8601": "2024-11-15T13:00:33.902769Z",
"url": "https://files.pythonhosted.org/packages/a8/94/2f1e80a5dc66839fb3951401bc9d674e9165ebf1e8a1e1909e29d2a94880/github_desktop_notifier-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "31a2ba69b5a06f89b4b0782ffcee248b6121cbec6760978b9c1698195c1239c9",
"md5": "41b10b8e822f3d71dd0d644657a5974f",
"sha256": "97607e64f295fae6dd7f241e2436f503bc18eb79b5ea4309aa449d7fbcfb357b"
},
"downloads": -1,
"filename": "github_desktop_notifier-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "41b10b8e822f3d71dd0d644657a5974f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6517,
"upload_time": "2024-11-15T13:00:35",
"upload_time_iso_8601": "2024-11-15T13:00:35.466358Z",
"url": "https://files.pythonhosted.org/packages/31/a2/ba69b5a06f89b4b0782ffcee248b6121cbec6760978b9c1698195c1239c9/github_desktop_notifier-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-15 13:00:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bytexenon",
"github_project": "Github-Desktop-Notifier",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": []
}
],
"lcname": "github-desktop-notifier"
}
JSON
