a pluggable irc bot framework in python
Project description
a pluggable irc bot framework in python
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.
Optional arguments are:
port: choose a custom port to connect to the server (default: 6667)
ops: list of operators who can do things like make the bot join other channels or quit (default: empty list)
plugin_dir: directory where the bot should look for plugins (default: “plugins”)
Creating plugins
In your chosen plugins directory (“plugins” by default) make a python file with a function. You can use the @pinhook.plugin.register decorator to tell the bot the command to activate the function.
The function will need to be structured as such:
import pinhook.plugin
@pinhook.plugin.register('!test')
def test_plugin(msg):
message = '{}: this is a test!'.format(msg.nick)
return pinhook.plugin.message(message)
The function will need to accept a single argument in order to accept a Message object from the bot.
The Message object has the following attributes:
cmd: the command that triggered the function
nick: the user who triggered the command
arg: all the trailing text after the command. This is what you will use to get optional information for the command
channel: the channel where the command was initiated
ops: the list of bot operators
botnick: the nickname of the bot
The plugin function must return one of the following in order to give a response to the command:
pinhook.plugin.message: basic message in channel where command was triggered
pinhook.plugin.action: CTCP action in the channel where command was triggered (basically like using /me does a thing)
Examples
There are some basic examples in the examples directory in this repository.
For a live and maintained bot running the current version of pinhook see pinhook-tilde.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pinhook-1.0.1.tar.gz
.
File metadata
- Download URL: pinhook-1.0.1.tar.gz
- Upload date:
- Size: 3.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
01e3da593592ee0abe3040403f81cf143dc7cccd6d613c56173458c597b757bb
|
|
MD5 |
a19961787ffe0bb8eec03e365fa9f049
|
|
BLAKE2b-256 |
453bd6ce13ab755d89c213935fae75d212fe416e420ce3ec2848041f2d8f1bd5
|
File details
Details for the file pinhook-1.0.1-py2.py3-none-any.whl
.
File metadata
- Download URL: pinhook-1.0.1-py2.py3-none-any.whl
- Upload date:
- Size: 4.1 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
79b3f5c104e51b72a6e4260f63d1cc95f05a854687ba6cd8ff6623d4805187c8
|
|
MD5 |
c91c4d03645dd41937b34b1c4d73f73e
|
|
BLAKE2b-256 |
5b20c6c7238bfdd8bfd481fa85162ccfcca5227e5984af05c1a47257000fd6ac
|