https://github.com/bd808/python-ib3

IRC bot framework using mixins to provide commonly desired functionality
https://github.com/bd808/python-ib3

irc irc-bot-framework python python3

Last synced: 9 months ago
JSON representation

IRC bot framework using mixins to provide commonly desired functionality

• Host: GitHub
• URL: https://github.com/bd808/python-ib3
• Owner: bd808
• License: gpl-3.0
• Created: 2017-02-20T18:27:33.000Z (about 9 years ago)
• Default Branch: main
• Last Pushed: 2023-12-18T19:01:40.000Z (over 2 years ago)
• Last Synced: 2025-03-29T01:51:45.532Z (about 1 year ago)
• Topics: irc, irc-bot-framework, python, python3
• Language: Python
• Homepage: https://python-ib3.readthedocs.io/
• Size: 55.7 KB
• Stars: 9
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • License: COPYING
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

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

IRC Bot Behavior Bundle (IB3)

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

IRC bot framework using mixins to provide commonly desired functionality.

Overview

========

The `irc`_ python library's ``irc.bot.SingleServerIRCBot`` provides a nice

base for making a new bot, but there are many common tasks needed by a robust

bot that it does not handle out of the box. IB3 collects some commonly desired

behaviors for a bot as `mixin`_ classes that can be used via `multiple

inheritance`_::

    from ib3 import Bot

    from ib3.auth import SASL

    from ib3.connection import SSL

    from ib3.mixins import DisconnectOnError

    class TestBot(SASL, SSL, DisconnectOnError, Bot):

        pass

Installation

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

* ``python3 -m pip install --upgrade ib3`` (recommended)

* ``python3 -m pip install .`` (from source distribution)

License

=======

IB3 is licensed under the `GPL-3.0-or-later`_ license.

Credits

=======

Some code and much inspiration taken from Wikimedia irc bots `Adminbot`_,

`Jouncebot`_, and `Stashbot`_.

.. _irc: https://pypi.org/project/irc/

.. _mixin: https://en.wikipedia.org/wiki/Mixin

.. _multiple inheritance: https://docs.python.org/3/tutorial/classes.html#multiple-inheritance

.. _GPL-3.0-or-later: https://www.gnu.org/copyleft/gpl.html

.. _Adminbot: https://phabricator.wikimedia.org/diffusion/ODAC/

.. _Jouncebot: https://phabricator.wikimedia.org/diffusion/GJOU/

.. _Stashbot: https://phabricator.wikimedia.org/diffusion/LTST/