kdb 1.0.2
Knowledge (IRC) Database Bot
License: MIT
Keywords: Knowledge Database IRC Bot Framework

.. _#circuits: http://webchat.freenode.net/?randomnick=1&channels=circuits&uio=d4
.. _FreeNode IRC Network: http://freenode.net

kdb is a small pluggable IRC Bot framework utilizing the
`circuits <http://circuitsframework.com/>`_
Python Application Framework.

kdb was one of the first "test" applications written
in circuits and is still maintained and kept up-to-date
with new features and changes in circuits.

You may use kdb as a framework to build your own projects that
use the IRC protocol. kdb itself comes with a suite of useful
plugins and features. If you'd like to see it in action, feel
free to get in touch with the developer
`James Mills <http://prologic.shortcircuit.net.au/>`_ (*prologic*)
on the FreeNode IRC Network who resides in the #circuits channel.

kdb was created by and is primarily maintained by
`James Mills <http://prologic.shortcircuit.net.au/>`_


- `Website <http://bitbucket.org/prologic/kdb/>`_
- `Issues <https://bitbucket.org/prologic/kdb/issues>`_
- `#circuits`_ on the `FreeNode IRC Network`_


Installation
------------

::
    
    $ pip install kdb


Usage
-----

::
    
    $ kdb irc.freenode.net

For other options::
    
    $ kdb --help


Installation and Usage on Docker
--------------------------------

kdb is now `Docker <https://docker.io>`_ ready and can be run with::
    
    $ CID=$(docker run -d -p 8000:8000 -v $(pwd)/etc:/etc/kdb --name="kdb" prologic/kdb --config=/etc/kdb/kdb.ini)

.. note:: Be sure to edit ``etc/kdb.ini`` or change the above line
          to suit your needs mounting the configuration directory
          from another path on your host.


Plugins
-------

kdb has a full complementary set of plugins available.

For a list of available plugins, see:

https://bitbucket.org/prologic/kdb/src/tip/kdb/plugins/


You may install the latest `Development Version <https://bitbucket.org/prologic/kdb/get/tip.zip#egg=kdb-dev>`_ via::
    
    $ pip install kdb==dev


Changes
-------


kdb 1.0.2 (*2014-04-27*)
........................

- Fixed a bug in the new Web API.
- Fixed a bug with ``kdb.plugins.help.format_msg()``.
- Updated the Web Plugin UI to use jQuery Terminal.
- Added a JSON RPC Plugin.
- Updated Drone Plugin to listen to ``registered`` and ``nick`` events.
- Fixed a typo in Greeting Plugin


kdb 1.0.1 (*2014-04-16*)
........................

- Fixed Web Plugin proper and make package non ``zip_safe``.
- Fixed templates path in Web Plugin.
- Fixed the Web Plugin so it works if installed as a package and run
  separately.


kdb 1.0.0 (*2014-04-16*)
........................

- Fixed missing ``html2text`` and ``aspell-en`` dependency.
- Updated requirements and Dockerfile
- Moved example config into ``etc/``
- Print a treceback on plugin load failure.
- Use ``os.path.exists`` to check for ``--config`` file.
- Fixed Dockerfile
- Added Remote Plugin Plugin
- Fixed sub-commands for Channels Plugin.
- Fixed state management.
- Set a filename to save RSS Feeds to for the RSS Plugin in the default
  sample configuration file.
- Fixed sub-commands with the Channels Plugin.
- Fixed display of ``RLIST`` command in RSS Plugin.
- Fixed counting usage statistics of commands.


kdb 0.9.0 (*2014-04-14*)
........................

- Ported to circuits 3.0