https://github.com/malexmave/issuebot

A XMPP MUC notification bot for new issues, loosely based on https://github.com/metajack/commitbot.
https://github.com/malexmave/issuebot

Last synced: 3 months ago
JSON representation

A XMPP MUC notification bot for new issues, loosely based on https://github.com/metajack/commitbot.

• Host: GitHub
• URL: https://github.com/malexmave/issuebot
• Owner: malexmave
• License: gpl-3.0
• Created: 2013-09-15T07:21:36.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2013-10-11T10:14:04.000Z (about 11 years ago)
• Last Synced: 2024-04-18T11:17:31.249Z (7 months ago)
• Language: Python
• Homepage: http://blog.velcommuta.de/2013/introducing-issuebot-a-jabber-muc-notification-bot-for-github/
• Size: 280 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-xmpp - issuebot - XMPP bot that notifies MUCs of changes to Issues on a GitHub-Project. (Bots)

README

        
issuebot

========

Issuebot is an XMPP bot that notifies multi-user chat rooms (MUCs) of

changes to Issues on a GitHub-Project.

It uses the [GitHub API](http://developer.github.com) to get issue details 

for the repositories it monitors.

## License

This code is licensed under the [GPLv3](http://www.gnu.org/licenses/gpl.html).

See `LICENSE.txt` for details.

Portions of this code are based on Code by Jack Moffitt  from

the [CommitBot](https://github.com/metajack/commitbot)-Project, (c) 2008.

## Dependencies

* [Twisted](http://www.twistedmatrix.com) 8.1.x or later

* [Wokkel](http://wokkel.ik.nu) 0.4 or later

Note that on Ubuntu/Debian systems Twisted is split into various

pieces.  You will want:

* python-twisted-words

* python-twisted-names

in addition to the normal Twisted package.

## Usage

Copy `issuebot.tac.example` to `issuebot.tac` changing the configuration parameters at the top to something appropriate. 

Then launch it with `twistd`.

    twistd -y issuebot.tac

If everything worked fine, a new user should have joined your MUC.

## Experts

If you want a high update frequency or monitor a high number of repositories,

please consider adding an OAuth key to increase your API limit from 60 / hour

to 5000 / hour. Set the token into the respective variable in the tac-file.

Instructions on how to obtain such a token can be found on the 

[GitHub developer site](https://developer.github.com/guides/getting-started/#authentication)

(look for the section on OAuth and follow the instructions, pasting the 

generated token into the variable as a String). You can also create such a 

token in your User settings under Applications => Personal Access tokens. This is entirely optional, but please note that GitHub may be angry if you exceed 

your Rate Limit, and the bot may crash.