https://github.com/fenhl/mwikiircbot

MediaWiki recent changes IRC bot
https://github.com/fenhl/mwikiircbot

irc mediawiki python python3

Last synced: 15 days ago
JSON representation

MediaWiki recent changes IRC bot

• Host: GitHub
• URL: https://github.com/fenhl/mwikiircbot
• Owner: fenhl
• License: mit
• Created: 2013-04-04T23:16:47.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2015-01-07T04:19:32.000Z (almost 10 years ago)
• Last Synced: 2023-03-28T21:53:02.555Z (over 1 year ago)
• Topics: irc, mediawiki, python, python3
• Language: Python
• Size: 316 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
**mwikiircbot** is an [IRC][] bot that sits in one or more IRC channels and posts a livestream of recent changes from a [MediaWiki][] to the channels. It uses [the Python IRC bot framework][PythonIRCBotFramework].

This is `mwikiircbot` verson 1.1.0 ([semver][Semver]). The versioned API includes the usage pattern, as found in the docstring of [`mwikiircbot.py`](mwikiircbot.py).

Configuration

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

*   Make sure [the Python IRC bot framework][PythonIRCBotFramework] and [docopt][Docopt] are in [the module search path][Pythonpath].

*   If your wiki is running MediaWiki 1.22 or higher, add a new entry to your [$wgRCFeeds](https://www.mediawiki.org/wiki/Manual:$wgRCFeeds) by adding the following to your `LocalSettings.php`:

    

    ```php

    $wgRCFeeds['mwikiircbot'] = array(

        'formatter' => 'IRCColourfulRCFeedFormatter',

        'uri' => 'udp://localhost:51666', # replace 'localhost' with the hostname where mwikiircbot will run

        'add_interwiki_prefix' => false,

        'omit_bots' => true,

    );

    ```

*   If your wiki is running MediaWiki 1.21 or lower:

    *   Set your wiki's [$wgRC2UDPAddress](https://www.mediawiki.org/wiki/Manual:$wgRC2UDPAddress) to an IP address or host name of the host where mwikiircbot will run.

    *   Set your wiki's [$wgRC2UDPPort](https://www.mediawiki.org/wiki/Manual:$wgRC2UDPPort) to `51666`, and [$wgRC2UDPPrefix](https://www.mediawiki.org/wiki/Manual:$wgRC2UDPPrefix) to the empty string.

Usage

=====

See the docstring in [`mwikiircbot.py`](mwikiircbot.py).

*   If specified, the bot will use `` as its IRC nick. The default value is MediaWiki.

*   Upon startup, the bot will connect to the IRC server specified by `` at port 6667, and join the ``s. Make sure to prefix the channels with `#`, and to escape the channel names when calling from a command line.

[Docopt]: https://docopt.org/ (docopt)

[IRC]: http://en.wikipedia.org/wiki/Internet_Relay_Chat (Wikipedia: Internet Relay Chat)

[MediaWiki]: http://www.mediawiki.org/wiki/MediaWiki (MediaWikiWiki: MediaWiki)

[PythonIRCBotFramework]: https://github.com/Fenhl/Python-IRC-Bot-Framework (github: Fenhl/Python-IRC-Bot-Framework)

[Pythonpath]: http://docs.python.org/3.3/tutorial/modules.html#the-module-search-path (Python 3.3 documentation: Modules: More on Modules: The Module Search Path)

[Semver]: http://semver.org/ (Semantic Versioning 2.0.0)