Gnotty

HomePage: http://github.com/stephenmcd/gnotty

Author: Stephen McDonald

Download: https://pypi.python.org/packages/source/G/Gnotty/Gnotty-0.2.6.tar.gz

        ======
Gnotty
======

Created by `Stephen McDonald <http://twitter.com/stephen_mcd>`_

Gnotty ties the knot between the web and IRC. It is designed to assist
open source projects that host an IRC channel for collaboration on
their project.
Gnotty is `BSD licensed <http://www.linfo.org/bsdlicense.html>`_.

Gnotty is comprised of several parts. Primarily Gnotty provides a
modern web client and server for communicating with an IRC channel via
a web browser. The web server uses `gevent <http://www.gevent.org>`_
and `WebSockets <http://en.wikipedia.org/wiki/WebSockets>`_, which
provides the communication layer between the IRC channel and the web
browser. Twitter's `Bootstrap <http://twitter.github.com/bootstrap/>`_
is used to style the web interface, providing a fully responsive
layout, suitable for use with mobile devices. Customisable templates
are also provided for skinning the web interface.

Check out the `Gnotty live demo <http://gnotty.jupo.org>`_ to see the
web interface in action.

Secondly, Gnotty provides the ability to run a highly customisable
IRC bot. Different classes of bots can be configured on startup, and
bots can perform different services such as message logging and
interacting with users in the IRC channel. Bots also contain webhooks,
which allows bots to receive and act on input over HTTP from external
services.

Gnotty also provides an optional Django application that archives IRC
messages, for browsing and searching via a web interface. By default
the IRC bot uses Python's logging module to provide configurable
logging handlers for IRC messages. When the Django application is
used, a logging handler is added that logs all IRC messages to the
Django project's database. The Django application then provides all
the necessary views and templates for messages to be searched by
keyword, or browsed by date using a calendar interface.

Note that the Django application is entirely optional. Gnotty can
be run without using Django at all, as a stand-alone gevent web
server that provides the web interface to an IRC channel, with
configurable IRC bots.


Installation
============

The easiest way to install Gnotty is directly from PyPi using
`pip <http://www.pip-installer.org>`_ by running the command below::

    $ pip install -U gnotty

Otherwise you can obtain Gnotty from the
`GitHub <https://github.com/stephenmcd/gnotty>`_ or
`Bitbucket <https://bitbucket.org/stephenmcd/gnotty>`_ repositories,
and install it directly from source::

    $ python setup.py install


Configuration
=============

Gnotty is configured via a handful of settings. When integrated
with Django, these settings can be defined in your Django project's
``settings.py`` module. When Gnotty is run as a stand-alone
client, these same settings can be defined via the command-line, or
in a separate Python configuration module. See the "Stand-Alone Web
Client" section below for details.

  * ``GNOTTY_HTTP_HOST`` - HTTP host address to serve from.
    *string, default: 127.0.0.1*
  * ``GNOTTY_HTTP_PORT`` - HTTP port to serve from.
    *integer, default: 8080*
  * ``GNOTTY_IRC_HOST`` - IRC host address to connect to.
    *string, default: irc.freenode.net*
  * ``GNOTTY_IRC_PORT`` - IRC port to connect to.
    *integer, default: 6667*
  * ``GNOTTY_IRC_CHANNEL`` - IRC channel to join.
    *string, default: #gnotty*
  * ``GNOTTY_IRC_CHANNEL_KEY`` - Optional key required to access
    the IRC channel.
    *string, default: None*
  * ``GNOTTY_BOT_CLASS`` - Dotted Python path to the IRC client bot
    class to run.
    *string, default: gnotty.bots.BaseBot*
  * ``GNOTTY_BOT_NICKNAME`` - IRC nickname the logging client will
    use.
    *string, default: gnotty*
  * ``GNOTTY_BOT_PASSWORD`` - Optional IRC password for the bot.
    *string, default: None*
  * ``GNOTTY_LOGIN_REQUIRED`` - Django login required for all URLs
    (Django only)
    *boolean, default: False*
  * ``GNOTTY_DAEMON`` - run in daemon mode.
    *boolean, default: False*
  * ``GNOTTY_PID_FILE`` - path to write PID file to when in daemon
    mode.
    *string, default: [tmp]/gnotty-[http-hos