blob: a968cbf4921cc93bbe21ce53e9b58e1f240bf8fd (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
* Setting up the bot
D'bolla is a no bullshit extensible IRC/Slack bot written for Python 3.5 using
asyncio.
** Install dependencies:
#+BEGIN_SRC bash
pip install websockets
#+END_SRC
** Configure
Copy dbolla.conf.example to dbolla.conf and edit this file. You can
specify multiples of the same connection by prefixing the config section with
'slack:' or 'irc:' followed by a unique name for this connection.
** Running
Simply run the command:
#+BEGIN_SRC bash
./bin/dbolla -c /path/to/my/dbolla.conf
#+END_SRC
* Writing a Plugin
* Writing a Connection
To write a new connection protocol you must inherit from
~warmachine.connections.base.Connection~. This class defines an interface you
must implement to support the plugins.
** ~__config_prefix__~
This global is used to decide which connection to use when it is found in the
config file. E.g. IRC uses ~'irc'~ and Slack uses ~'slack'~. It should be
defined somewhere near the top of your file.
** ~connect()~
D'bolla uses python 3's asyncio to manage multiple connections concurrently thus
you should use ~asyncio.open_connection~ to create your connection. Once you
have successfully connected you must set ~self.status~ to
~warmachine.connections.base.CONNECTED~. This indicates the connection is ready
to use.
** ~read()~
This method is constantly checked in a loop by the ~Bot~ class. When a message
is returned it is passed into the ~recv_msg~ method in all loaded plugins. This
return value should be formatted in the following format:
#+BEGIN_SRC python
{
'sender': 'sender nickname',
'channel': '#channel_name or None for private messages',
'message': 'The message that was received',
}
#+END_SRC
** ~say(message, destination)~
This method is used by plugins to send a message to a channel or user.
** ~id~
This should return a unique id used to identify this particular connection. This
is used by plugins when saving state. As an example, the IRC connection uses
something like this:
#+BEGIN_SRC python
@property
@warmachine.utils.decorators.memoize
def id(self):
from hashlib import md5
value = '{}-{}'.format(self.host, self.nick)
return md5(value.encode()).hexdigest()
#+END_SRC
** ~get_users_by_channel(channel)~
This method should return a list of all users (including the bot) for the
connection.
|
