Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Framework to program bots !!

Project description

BL is a python3 framework to use if you want to program CLI, IRC or XMPP bots.

features

BL provides the following features:

object class           save/load to/from a json file.
rest server            serve saved object’s over http.
rss fetcher            echo rss feeds to irc channels.
udp server             udp to bot to irc channel.
watcher server         run tail -f and have output send to IRC channel.
email scanning         scan mbox format to searchable bl objects.
json backend           objects are stored as json string in files on the fs.
db                     iteration over stored objects.
timestamp              time based filenames gives logging capabilities
future                 future sensors should provide entry to the logger.

install

Clone the source:

bart@okdan:~$ hg clone https://bitbucket.org/thatebart/bl

You might need to do one of the following if the bot doesn't work:

bart@okdan:~/bl$ export PYTHONPATH="."
bart@okdan:~/bl$ export PYTHONIOENCODING="utf-8"

Another option is to download with pip3 and install globally:

bart@okdan:~$ pip3 install bl --upgrade

irc

Use -n <nick>, -s <server>, -c <channel> options to make the bot join the network:

bart@okdan:~$ bot -i irc -n bl -s irc.freenode.net -c \#bl

You can use the -w option to write config values to ~/.bot/config/irc

xmpp

For the xmpp bot use the -i xmpp and –room arguments:

bart@okdan:~$ bot -i xmpp --room=test@conference.localhost

users

One needs to add a users origin to be able to give the bot commands. One can add a user with the meet command:

bart@okdan:~$ bot meet user@server
user user@server created

To give the user a permission you can use the perm command:

bart@okdan:~$ bot perm user@server ps
ok user@server

The u command show the json dump of a user object:

bart@okdan:~$ bot u user@server
{
    "_container": {
        "default": "",
        "path": "/home/bart/.bot/user/2017-10-12/21:05:52.095737",
        "prefix": "object",
        "saved": "Thu Oct 12 21:07:03 2017",
        "signature": "c113c4125f8c2a88d5b312e283792ae019c61a52"
    },
    "_type": "<class 'bl.object.Object'>",
    "origin": "user@server",
    "perms": [
        "USER",
        "PS"
    ],
    "user": "user@server"
}

The default shell user is root@shell and gives access to all the commands that are available.

commands

The following commands are available:

alias                 key, value alias.
announce              announce text on all channels in fleet.
begin                 begin stopwatch.
cfg                   edit config files.
cmnds                 show list of commands.
deleted               show deleted records.
delperm               delete permissions of an user.
dump                  dump objects matching the given criteria.
edit                  edit and save objects.
end                   stop stopwatch.
exit                  stop the bot.
fetcher               fetch all rss feeds.
find                  present a list of objects based on prompt input.
first                 show the first record matching the given criteria.
fix                   fix a object by loading and saving it.
idle                  see how long a channel/nick has been idle.
last                  show last objectect matching the criteria.
license               display BL license.
load                  force a plugin reload.
log                   log some text.
loglevel              set loglevel.
loud                  disable silent mode of a bot.
ls                    show subdirs in working directory.
man                   show descriptions of the available commands.
mbox                  convert emails to bl objects.
meet                  create an user record.
nick                  change bot nick on IRC.
perm                  add/change permissions of an user.
permissions           show permissions granted to a user.
perms                 show permission of user.
pid                   show pid of the BL bot.
ps                    show running threads.
reboot                reboot the bot, allowing statefull reboot (keeping connections alive).
reload                reload a plugin.
restore               set deleted=False in selected records.
rm                    set deleted flag on objects.
rss                   add a rss url.
save                  make a kernel dump.
shop                  add a shopitem to the shopping list.
show                  show dumps of basic objects.
silent                put a bot into silent mode.
start                 start a plugin.
stop                  stop a plugin.
synchronize           synchronize rss feeds (fetch but don't show).
test                  echo origin.
timer                 timer command to schedule a text to be printed on a given time. stopwatch to measure elapsed time.
today                 show last week's logged objects.
todo                  log a todo item.
tomorrow              show todo items for tomorrow.
u                     show user selected by userhost.
uptime                show uptime.
version               show version.
w                     show user data.
watch                 add a file to watch (monitor and relay to channel).
week                  show last week's logged objects.
whoami                show origin.
yesterday             show last week's logged objects.

modules

The following modules are available:

bl                     bl package.
bl.bot         bot base class.
bl.cli         command line interfacce bot, gives a shell prompt to issue bot commands.
bl.clock               timer, repeater and other clock based classes.
bl.cmnds               bl basic commands.
bl.compose             construct a object into it’s type.
bl.decorator           method decorators
bl.db          JSON file db.
bl.engine              select.epoll event loop, easily interrup_table esp. versus a blocking event loop.
bl.error               bl exceptions.
bl.event               event handling classes.
bl.fleet               fleet is a list of bots.
bl.handler             schedule events.
bl.irc         IRC bot class.
bl.launcher            a launcher launches threads (or tasks in this case).
bl.log         log module to set standard format of logging.
bl.object              JSON file backed object with dotted access.
bl.raw         raw output using print.
bl.rss         rss module.
bl.selector            functions used in code to select what objects to use.
bl.task                adapted thread to add extra functionality to threads.
bl.trace               functions concering stack trace.
bl.users               class to access user records.
bl.xmpp                XMPP bot class.
bl.register            object with list for multiple values.
bl.rest                rest interface.
bl.runner              threaded loop to run tasks on.
bl.space               central module to store objects in.
bl.static              static definitions.
bl.template            cfg objects containing default values for various services and plugins.
bl.test                plugin containing test commands and classes.
bl.udp         relay txt through a udp port listener.
bl.utils               lib local helper functions.
bl.url         functions that fetch data from url.
bl.watcher             watch files.
bl.worker              worker thread that handles submitted jobs through Worker.put(func, args, kwargs).

programming

BL makes it possible to program your own module enabling your own commands.

code example:

def hi(event):
    event.reply("hi %s" % event.origin)

user programmed modules are read from a botmods directory in your current working directory, you can put your .py files over there.

license

BL has a MIT license.

# -*- coding: utf-8 -*-
#
# BL Framework to program bots
#
# LICENSE
#
# Copyright 2017,2018 B.H.J Thate
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice don't have to be included.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# Bart Thate
# Heerhugowaard
# The Netherlands

contact

Bart Thate
botfather on #dunkbot irc.freenode.net

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for blib, version 3
Filename, size File type Python version Upload date Hashes
Filename, size blib-3.tar.gz (55.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page