Source code for fatbotslim.cli

# -*- coding: utf-8 -*-
# This file is part of FatBotSlim.
# FatBotSlim is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# FatBotSlim is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with FatBotSlim. If not, see <>.
.. module:: fatbotslim.cli

.. moduleauthor:: Mathieu D. (MatToufoutu)

This module contains utilities to run a bot from the command line.

from argparse import ArgumentParser, ArgumentDefaultsHelpFormatter

from gevent import spawn

from fatbotslim import NAME, VERSION
from import IRC
from fatbotslim.log import create_logger

log = create_logger(__name__)

[docs]def make_parser(): """ Creates an argument parser configured with options to run a bot from the command line. :return: configured argument parser :rtype: :class:`argparse.ArgumentParser` """ parser = ArgumentParser( description='Start an IRC bot instance from the command line.', formatter_class=ArgumentDefaultsHelpFormatter, ) parser.add_argument( '-v', '--version', action='version', version='{0} v{1}'.format(NAME, VERSION) ) parser.add_argument( '-s', '--server', metavar='HOST', required=True, help='the host to connect to' ) parser.add_argument( '-p', '--port', metavar='PORT', type=int, default=6667, help='the port the server is listening on' ) parser.add_argument( '-n', '--nick', metavar='NAME', required=True, help="the bot's nickname" ) parser.add_argument( '-N', '--name', metavar='NAME', default=NAME, help="the bot's real name" ) parser.add_argument( '-c', '--channels', metavar='CHAN', nargs='*', help='join this channel upon connection' ) parser.add_argument( '-l', '--log', metavar='LEVEL', default='INFO', help='minimal level for displayed logging messages' ) parser.add_argument( '-S', '--ssl', action='store_true', help='connect to the server using SSL' ) return parser
[docs]def make_bot(): """ Creates a new bot instance ready to be launched. """ parser = make_parser() args = parser.parse_args() settings = { 'server': args.server, 'port': args.port, 'ssl': args.ssl, 'nick': args.nick, 'realname':, 'channels': args.channels or [], 'loglevel': args.log, } return IRC(settings)
[docs]def main(bot): """ Entry point for the command line launcher. :param bot: the IRC bot to run :type bot: :class:`` """ greenlet = spawn( try: greenlet.join() except KeyboardInterrupt: print '' # cosmetics matters"Killed by user, disconnecting...") bot.disconnect() finally: greenlet.kill()