Skip to content

hwine/gh_notifications

Repository files navigation

gh_notifications

gh_notifications is a library to access GitHub Notifications. It comes with a cli & (eventually) a web interface.

Folks who work with many organizations which require SAML authentication may find this tool more convenient to use, as authentication is handled by a PAT (avoiding daily login to each SAML backed organization).

N.B. this project is a learn-by-doing for me on library combined with cli & web access using hatch & PyGithub. Expect rough edges!

Table of Contents

Installation

This is not packaged yet, so running from a clone is recommended.

INSTALL_DIR=/path/to/parent/dir/gh_notifications
cd $INSTALL_DIR
cd ..
git clone https://github.com/hwine/gh_notifications.git

Usage

The script uses hatch, so that is the recommended approach for now. Install with:

pipx install hatch

For the moment, it only lists unread notifications, grouped by repository, via the command:

cd $INSTALL_DIR
hatch run python -m gh_notifications

Caveat: currently, this only reports repository notifications. It does not include dependabot or security notifications.

Authentication

This script expects a (classic) PAT with permissions for notifications to be available as the value of the GITHUB_TOKEN environment variable. If you store that token in 1Password as "GH notification PAT", you can load it by sourcing the load_gh_token script.

License

gh-notifications is distributed under the terms of the Apache-2.0 license.

About

WIP to display unread notifications by repo

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages