Skip to main content

Yet another IRC bot library

Project description

Flattr this repo

FatBotSlim

Yet another Python IRC bot library…

Features:

  • asynchronous

  • multi-server

  • easy to use plugin system

  • rights management for user-defined commands

  • automated help messages generation for custom plugins

  • colored logging

  • colored IRC messages

  • command line parser to set your custom bot settings from the console

Dependencies:

  • gevent

  • chardet

Installation:

  • From GitHub:

    git clone https://github.com/mattoufoutu/fatbotslim.git
    cd fatbotslim
    python setup.py install
  • From PyPI:

    pip install fatbotslim

Documentation:

The documentation is hosted on readthedocs and is available in the following formats:

Example:

This very simple bot answers Hello <username>! when someone says !hello in a public message.

Using the fatbotslim.cli helpers also gives your bot an integrated command line arguments parser.

For more detailed informations about writing custom handlers and more complex bots, please refer to the documentation.

from fatbotslim.cli import make_bot, main
from fatbotslim.handlers import CommandHandler, EVT_PUBLIC

class HelloCommand(CommandHandler):
    triggers = {
        'hello': [EVT_PUBLIC],
    }

    def hello(self, msg):
        self.irc.msg(msg.dst, "Hello {0}!".format(msg.src.name))

bot = make_bot()
bot.add_handler(HelloCommand)
main(bot)

Just try it!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

FatBotSlim-0.2.tar.gz (14.4 kB view details)

Uploaded Source

File details

Details for the file FatBotSlim-0.2.tar.gz.

File metadata

  • Download URL: FatBotSlim-0.2.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for FatBotSlim-0.2.tar.gz
Algorithm Hash digest
SHA256 38905875531c8616384d8cdf7e77ce8cf4420e1823a629e8c1f57ddd9c7ab840
MD5 3285a3e3d54360637f6831d08873e21d
BLAKE2b-256 016fa6d823175922660d030f0ed106f88223075aab699952d86a9e86de4264bc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page