Giter Club home page Giter Club logo

github-notifier's Introduction

Github-notifier

This is a Linux/Python port of miyagawa's github-growler.

It fetches your Github dashboard feeds and displays a notification for new items. There is additional features like filtering only notifications from important authors and/or projects. The GitHub blog entries can also be seen in the notifications if desired.

Requirements

  • python 2.5, 2.6 or 2.7
  • feedparser
  • simplejson (not needed for python 2.6)

Install

First install the package dependencies (using Ubuntu)

sudo apt-get install python-gtk2 python-feedparser python-simplejson

Then clone the repository and install the module:

git clone git://github.com/abiczo/github-notifier.git
cd github-notifier
python setup.py install

Now you can run github-notifier like this:

github-notifier

Use --help for a list of available command line options.

Packages

An Arch Linux package is available here.

Screenshot

Screenshot using notify-osd:

Screenshot

Organizations Feeds Feature

The user's organizations are monitored by default. But you can use the filtering feature to blacklist some organizations.

Filtering Feature

Authors are filtered when using the -a flag. Projects are filtered when using the -p flag. -k to blacklist organizations. A config.cfg file is present within your ~/.githubnotifier/ directory. The file will be generated if it is not present at run-time.

The config.cfg format is as follows:

[important]
authors=bob,fred,mary
projects=github-notifier,rails,bob/my-project
[blacklist]
authors=james
projects=bad_project
organizations=LogicalBricks

This configuration will only show notifications that have bob, fred or mary as the authors. The projects can either be in a general format (ex: github-notifier or rails) to only show notifications that deal with either of those projects. The general format will show notifications that match the project name, regardless of who is the owner of the repository. The stricter format (ex: bob/my-project) will only show notifications of the my-project repository if the owner if bob.

It is also possible to completely blacklist notifications from certain authors and/or projects. This is configured the same way as for important projects, but now the configuration falls under the blacklist category, the organizations can be filtered using the login (ex: LogicalBricks,Github), comma separated.

Filters for important authors/projects will override filters for blacklisted authors/projects if they both are enabled.

TODO

  • Expire the user info and avatar caches after some time
  • Notify-osd has problems when the notification message contains an '&' character
  • Build a preferences dialog

Notes

The Octocat logo is taken from http://github.com/mojombo/github-media.

github-notifier's People

Contributors

abiczo avatar kevinjalbert avatar niftylettuce avatar tkf avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.