the pluggable python framework for IRC bots and Twitch bots
Go to file
Mallory Hancock 2b5c63de01 add some tutorial 2017-10-02 10:28:39 -07:00
examples update plugin example 2017-09-28 06:33:28 -07:00
pinhook add cmd to kwargs given to plugins 2017-09-28 09:35:46 -07:00
.gitignore Initial commit 2017-09-27 12:03:20 -07:00
LICENSE Initial commit 2017-09-27 12:03:20 -07:00
README.md add some tutorial 2017-10-02 10:28:39 -07:00
setup.py add barebones setup.py 2017-09-27 15:44:32 -07:00

README.md

pinhook

a pluggable irc bot framework in python

Currently in very early stages and may change wildly until final release

Tutorial

Installation

$ pip install git+git://github.com/archangelic/pinhook.git

Creating the Bot

To create the bot, just create a python file with the following:

import pinhook.bot

bot = pinhook.bot.Bot(channels=['#foo', '#bar'], nickname='ph-bot', server='irc.freenode.net')
bot.start()

This will start a basic bot and look for plugins in the 'plugins' directory to add functionality.

Optionally, you can change the port and add a list of operators with the ops argument.