gh-notifier
A Desktop notifier for all your "social" GitHub notifications.
Why gh-notifier ?
- Because growing your developer network matters.
- Because we all are excited by the response we get on our projects.
- Because we love Terminal.
- Because nobody else does this (not even GitHub itself).
- Because this is cool.
- Because this helped me learn.
Features
Currently, it notifies a user when:
- [x] someone follows them
- [x] someone stars/forks/watches their repository
Installtion Guide
For Linux and MacOSX users
Note: Python3 is needed to run this application. So, if you haven't already downloaded it, kindly download it from here.
-
Download the package from PyPI via
pip(orpip3) using :
pip3 install ghnotifier
Usesudoif need be. -
Run
ghnotifiercommand in a terminal to set up your credentials and get your notifications.
Adding to crontab
In order to make the most out of the app, I would suggest you to add it to your crontab. If you aren't comfortable with the process of adding a command to the crontab, then continue reading.
# Adding the ghnotifier to crontab
$ crontab -e
# In order to run the command every minute(the setting I use), add the following line to your crontab.
* * * * * ghnotifier
Note (For MacOSX users): Apart from the above steps, I recommend you to download terminal-notifier from @julienXX.
Troubleshooting crontab:
I faced a few issues while adding the command to my crontabs on both Ubuntu 16.04 and MacOSX Sierra. Hence, I thought of sharing a few hacks for helping you:
For MacOSX:
- In-place editing with vim: http://stackoverflow.com/q/15395479/4927751
-
Exporting to your favourite Text editor:
EDITOR=your_editor crontab -eFor Ubuntu:
- Common issues with installing crontab : http://askubuntu.com/q/23009/434885
-
Example script for inspiration : https://github.com/kshitij10496/gh-notifier/blob/master/cronscript.sh
If you face any issue with the installation, feel free to reach out to me.
Contributing
Please feel free to report any discrepancy/suggestions on the [Issues Tracker](). If you have any feature requests, comment on this [thread](). I will try to implement them. More so, feel free to open a Pull Request.