taeguk / github_listener

The simple library that calls user's registered functions whenever github events happen. (ex, notification)

Github Listener

The simple library that calls user's registered functions whenever github events happen.

How to install

You can install Github Listener using pip :

$ pip install github_listener

Feature Support

• Notification
• ...If you have things you want, please tell me through issues.

Example

from github_listener import (
  GithubAccount,
  GithubListener,
)

account = GithubAccount("username", "password")
listener = GithubListener(account)

@listener.notification
def on_notification(change):
  # Do things that you want to do whenever the github's notification occurs.
  pass

listener.run()  # infinite loop

from github_listener import GithubAccount
from github_listener.github_api import NotificationAPI

account = GithubAccount("username", "password")
api = NotificationAPI(account)
groups = api.get_notification_groups()

# Do something using notification informations.

For more detail examples, Go Examples.

Contribution

Welcome any kind of contribution!

github_listener's Issues

Increasing requests per time.

Like #1 , the limit of requests(or login) exists in current.
The solution to increase the rate is needed.

Creating a listener causes a type error: TypeError: super() takes at least 1 argument (0 given)

account = GithubAccount("username", "password")
listener = GithubListener(account)

listener = GithubListener(account)
  File "/Library/Python/2.7/site-packages/github_listener/github_listener.py", line 49, in __init__
    self.event_checker = GithubEventChecker(account)
  File "/Library/Python/2.7/site-packages/github_listener/github_listener.py", line 32, in __init__
    self.notification_checker = NotificationChecker(account)
  File "/Library/Python/2.7/site-packages/github_listener/notification.py", line 35, in __init__
    self.notification_api = NotificationAPI(account)
  File "/Library/Python/2.7/site-packages/github_listener/github_api/notification_api.py", line 34, in __init__
    super().__init__(account)
TypeError: super() takes at least 1 argument (0 given)

Max retries exceeded with url: /notifications

requests.exceptions.ConnectionError: HTTPSConnectionPool(host='api.github.com', port=443): Max retries exceeded with url: /notifications (Caused by NewConnectionError('<requests.packages.urllib3.connection.VerifiedHTTPSConnection object at 0xb6ba338c>: Failed to establish a new connection: [Errno -5] No address associated with hostname',))

When Github Account is invalid, exception message is strange.

This exception occurs when github account is invalid.
Exception or error message need to be noticeable to user.

Max retries exceeded with url: /session

This problem is caused from refusing my connection of Github Server.
What is the solutions...?

1. Adjust time gap of requests to Github.
   Current, default time gap is 0.5 sec.
   If you adjust it, listener.run(time_gap)
2. I have to think....

Using Github API instead of parsing.

https://developer.github.com/v3/activity/notifications/
I forgot that Github API of notifications exists.
What is more better between Github API and Parsing?

Can't use Gist with github_listener

Can't use Gist with github_listener....
A Unicorn appears.....:(

The problem is that github_listener login to github so much. (so many access to /session)
Related Issue is #1 .