README.md

py3status-github-notifications

py3status module for showing your Github notifications in i3

Screenshot

Prerequisites

• i3wm
• py3status
• pygithub
• Notification API token from Github
• Awesome Terminal Fonts

Getting your Notification API Token

You can get this directly on Github, by going to your own Account settings, Developer Settings and finally Personal access tokens.

Make sure to limit the access to ONLY notifications.

Installation

There are several methods to install py3status-github-notifications.

Directly from Github using git, pip / pipenv or poetry, the AUR (Arch package).

Direct From Github

Installing directly from Github with git, means you will need to make sure you have the dependencies already installed.

git clone [email protected]:mcgillij/py3status-github-notifications.git
mkdir -p ~/.i3/py3status/ && cd ~/i3/py3status/
ln -s ../../py3status-github-notifications/src/py3status_github_notifications/github_notifications.py ./

And down to the configuration section.

Installing with Pip, Pipenv or Poetry

You will need to install the fonts separately to get the emoji.

pip install py3status-github-notifications
pipenv install py3status-github-notifications
poetry add py3status-github-notifications

With yay

yay -S py3status-github-notifications

Configuration

Once you have the module installed using whichever method you chose above, edit your py3status configuration and add the following options.

~/.config/i3/i3status.conf

...

order += "github_notifications"

github_notifications {
    gh_token = "PASTE YOUR NOTIFICATIONS ONLY TOKEN HERE"
    on_click 1 = "exec xdg-open https://github.com/notifications"$
}
...

And restart i3 and your should be good to go.

Configuration Options

You can pass in the following configuration options:

• cache_timeout # default 300