pinhook/README.md

191 lines
6.8 KiB
Markdown
Raw Normal View History

2017-09-27 19:03:20 +00:00
# pinhook
2019-08-30 20:29:05 +00:00
[![Supported Python versions](https://img.shields.io/pypi/pyversions/pinhook.svg)](https://pypi.org/project/pinhook) [![Package License](https://img.shields.io/pypi/l/pinhook.svg)](https://github.com/archangelic/pinhook/blob/master/LICENSE) [![PyPI package format](https://img.shields.io/pypi/format/pinhook.svg)](https://pypi.org/project/pinhook) [![Package development status](https://img.shields.io/pypi/status/pinhook.svg)](https://pypi.org/project/pinhook) [![With love from tilde.town](https://img.shields.io/badge/with%20love%20from-tilde%20town-e0b0ff.svg)](https://tilde.town)
2019-08-30 20:29:05 +00:00
The pluggable python framework for IRC bots and Twitch bots
* [Installation](#installation)
* [Creating an IRC Bot](#creating-an-irc-bot)
* [From Config File](#from-config-file)
* [From Python File](#from-python-file)
* [Creating a Twitch Bot](#creating-a-twitch-bot)
* [Creating plugins](#creating-plugins)
* [Examples](#examples)
## Installation
2017-09-28 13:34:07 +00:00
2019-08-30 20:29:05 +00:00
Pinhook can be installed from PyPI:
``` bash
pip install pinhook
2017-10-02 17:28:39 +00:00
```
2019-08-30 20:29:05 +00:00
## Creating an IRC Bot
A pinhook bot can be initialized using the command line tool `pinhook` with a config file, or by importing it into a python file to extend the base class.
### From Config File
Pinhook supports configuration files in YAML, TOML, and JSON formats.
Example YAML config:
```YAML
nickname: "ph-bot"
server: "irc.somewhere.net"
channels:
- "#foo"
- "#bar"
```
Required configuration keys:
* `nickname`: (string) nickname for your bot
* `server`: (string) server for the bot to connect
* `channels`: (array of strings) list of channels to connect to once connected
Optional keys:
* `port`: (default: `6667`) choose a custom port to connect to the server
* `ops`: (default: empty list) list of operators who can do things like make the bot join other channels or quit
* `plugin_dir`: (default: `"plugins"`) directory where the bot should look for plugins
* `log_level`: (default: `"info"`) string indicating logging level. Logging can be disabled by setting this to `"off"`
* `ns_pass`: this is the password to identify with nickserv
* `server_pass`: password for the server
* `ssl_required`: (default: `False`) boolean to turn ssl on or off
Once you have your configuration file ready and your plugins in place, you can start your bot from the command line:
```bash
pinhook config.yaml
2017-10-02 17:28:39 +00:00
```
2019-08-30 20:29:05 +00:00
Pinhook will try to detect the config format from the file extension, but the format can also be supplied using the `--format` option.
```bash
$ pinhook --help
Usage: pinhook [OPTIONS] CONFIG
Options:
-f, --format [json|yaml|toml]
--help Show this message and exit.
```
### From Python File
2017-10-02 17:28:39 +00:00
To create the bot, just create a python file with the following:
```python
2018-02-07 18:33:30 +00:00
from pinhook.bot import Bot
2017-10-02 17:28:39 +00:00
2018-02-07 18:33:30 +00:00
bot = Bot(
2017-10-02 17:48:46 +00:00
channels=['#foo', '#bar'],
nickname='ph-bot',
server='irc.freenode.net'
)
2017-10-02 17:28:39 +00:00
bot.start()
```
This will start a basic bot and look for plugins in the 'plugins' directory to add functionality.
2017-10-02 17:48:46 +00:00
Optional arguments are:
2019-08-30 20:29:05 +00:00
* `port`: (default: `6667`) choose a custom port to connect to the server
* `ops`: (default: empty list) list of operators who can do things like make the bot join other channels or quit
* `plugin_dir`: (default: `"plugins"`) directory where the bot should look for plugins
* `log_level`: (default: `"info"`) string indicating logging level. Logging can be disabled by setting this to `"off"`
2018-02-06 00:38:53 +00:00
* `ns_pass`: this is the password to identify with nickserv
* `server_pass`: password for the server
2019-08-30 20:29:05 +00:00
* `ssl_required`: (default: `False`) boolean to turn ssl on or off
## Creating a Twitch Bot
2018-02-06 00:38:53 +00:00
Pinhook has a baked in way to connect directly to a twitch channel
```python
2018-02-07 18:33:30 +00:00
from pinhook.bot import TwitchBot
2018-02-06 00:38:53 +00:00
2018-02-07 18:33:30 +00:00
bot = TwitchBot(
2018-02-06 00:38:53 +00:00
nickname='ph-bot',
channel='#channel',
token='super-secret-oauth-token'
)
bot.start()
```
2019-08-30 20:29:05 +00:00
2018-02-06 00:38:53 +00:00
This function has far less options, as the server, port, and ssl are already handled by twitch.
Optional aguments are:
2019-08-30 20:29:05 +00:00
2018-02-06 00:38:53 +00:00
* `ops`
* `plugin_dir`
* `log_level`
These options are the same for both IRC and Twitch
2017-10-02 17:48:46 +00:00
2019-08-30 20:29:05 +00:00
## Creating plugins
2019-01-24 17:46:44 +00:00
There are two types of plugins, commands and listeners. Commands only activate if a message starts with the command word, while listeners receive all messages and are parsed by the plugin for maximum flexibility.
In your chosen plugins directory ("plugins" by default) make a python file with a function. You use the `@pinhook.plugin.register` decorator to create command plugins, or `@pinhook.plugin.listener` to create listeners.
2017-10-02 17:48:46 +00:00
The function will need to be structured as such:
2019-08-30 20:29:05 +00:00
2017-10-02 17:48:46 +00:00
```python
import pinhook.plugin
@pinhook.plugin.register('!test')
2017-10-10 15:56:41 +00:00
def test_plugin(msg):
message = '{}: this is a test!'.format(msg.nick)
2017-10-02 17:48:46 +00:00
return pinhook.plugin.message(message)
```
2017-10-10 15:56:41 +00:00
The function will need to accept a single argument in order to accept a `Message` object from the bot.
2017-10-02 17:48:46 +00:00
2017-10-10 15:56:41 +00:00
The `Message` object has the following attributes:
2019-08-30 20:29:05 +00:00
* `cmd`: (for command plugins) the command that triggered the function
2017-10-02 17:48:46 +00:00
* `nick`: the user who triggered the command
* `arg`: (for command plugins) all the trailing text after the command. This is what you will use to get optional information for the command
* `text`: (for listener plugins) the entire text of the message
2017-10-10 15:56:41 +00:00
* `channel`: the channel where the command was initiated
* `ops`: the list of bot operators
* `botnick`: the nickname of the bot
2018-01-10 22:42:55 +00:00
* `logger`: instance of `Bot`'s logger
* `datetime`: aware `datetime.datetime` object when the `Message` object was created
* `timestamp`: float for the unix timestamp when the `Message` object was created
2019-08-30 20:29:05 +00:00
* `bot`: the initialized Bot class
2017-10-02 17:48:46 +00:00
It also contains the following IRC functions:
2019-08-30 20:29:05 +00:00
* `privmsg`: send a message to an arbitrary channel or user
* `action`: same as privmsg, but does a CTCP action. (i.e., `/me does a thing`)
* `notice`: send a notice
You can optionally use the `@pinhook.plugin.ops` decorator to denote that a command should only be executable by a bot op.
2019-08-30 20:29:05 +00:00
* If you specify the optional second argument, it will be displayed when a non-op attempts to execute the command
The function will need to be structured as such:
2019-08-30 20:29:05 +00:00
```python
@pinhook.plugin.register('!test')
@pinhook.plugin.ops('!test', 'Only ops can run this command!')
def test_plugin(msg):
return pinhook.plugin.message('This was run by an op!')
```
The plugin function can return one of the following in order to give a response to the command:
2019-08-30 20:29:05 +00:00
2017-10-02 18:25:59 +00:00
* `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`)
2017-10-02 18:19:54 +00:00
## Examples
2019-08-30 20:29:05 +00:00
2017-10-02 18:19:54 +00:00
There are some basic examples in the `examples` directory in this repository.
2019-01-24 17:46:44 +00:00
Here is a list of live bots using pinhook:
2019-08-30 20:29:05 +00:00
2019-01-24 17:46:44 +00:00
* [pinhook-tilde](https://github.com/archangelic/pinhook-tilde) - fun bot for tilde.town
* [adminbot](https://github.com/tildetown/adminbot) - admin helper bot for tilde.town, featuring some of the ways you can change the Bot class to suit your needs