https://github.com/taeguk/github_listener

The simple library that calls user's registered functions whenever github events happen. (ex, notification)
https://github.com/taeguk/github_listener

github library python3

Last synced: 7 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/taeguk/github_listener
• Owner: taeguk
• License: mit
• Created: 2016-03-28T12:54:54.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2016-06-09T06:55:15.000Z (over 9 years ago)
• Last Synced: 2025-03-27T11:11:11.822Z (10 months ago)
• Topics: github, library, python3
• Language: Python
• Homepage:
• Size: 520 KB
• Stars: 9
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
Github Listener

=====================

.. image:: https://img.shields.io/pypi/v/github_listener.svg

    :target: https://pypi.python.org/pypi/github_listener

.. image:: https://img.shields.io/pypi/dm/github_listener.svg

    :target: https://pypi.python.org/pypi/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 :

.. code-block:: bash

    $ pip install github_listener

Feature Support

--------------------

- Notification

- ...If you have things you want, please tell me through issues_.

.. _issues: https://github.com/taeguk/github_listener/issues

Example

---------------

.. code-block:: python

    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

.. code-block:: python

    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_.

.. _Examples: https://github.com/taeguk/github_listener/tree/master/examples

Contribution

-----------------

Welcome any kind of contribution!