https://github.com/stylesuxx/py-irc-bot

Simple, extensible python IRC bot based on pythons IRC library
https://github.com/stylesuxx/py-irc-bot

Last synced: about 1 month ago
JSON representation

Simple, extensible python IRC bot based on pythons IRC library

• Host: GitHub
• URL: https://github.com/stylesuxx/py-irc-bot
• Owner: stylesuxx
• Created: 2016-01-20T14:33:52.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-01-20T14:34:21.000Z (almost 9 years ago)
• Last Synced: 2023-03-13T08:15:46.331Z (over 1 year ago)
• Language: Python
• Size: 3.91 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Python IRC Bot

> A simple, extensible python IRC bot based on pythons IRC library.

## Setup

The bot setup happens in *__main__.py*. There you can set all the connection details and it is also the place where you load the modules you want to use.

## Run

To run the bot simply invoke it as a module from *outside* the root directory:

'''Bash

python -m py-irc-bot

'''

## Extend

This IRC bot is simple to extend with modules. There is an Abstract Base Class in place which modules need to use in order that they can be loaded. Modules have to be in the *modules* directory of the project. See the example **Support** module located in *modules/Support.py* for more details.

## Available commands

The only command that is always available is the *help* command. All other commands need to be implemented by a module.

## Dependencies

To install all dependencies needed (on a Debian based system) run:

```Bash

sudo pip install irc

```