Metadata-Version: 1.1
Name: irclogger
Version: 0.0.2
Summary: Python IRC Logger Daemon
Home-page: https://bitbucket.org/prologic/irclogger
Author: James Mills
Author-email: James Mills, prologic at shortcircuit dot net dot au
License: MIT
Download-URL: 0.0.2/get/0.0.2.zip
Description: .. _Python Programming Language: http://www.python.org/
        .. _circuits: http://pypi.python.org/pypi/circuits
        .. _irclog2html: http://pypi.python.org/pypi/irclog2html
        
        
        irclogger is a simple daemon written in the `Python Programming Language`_ utilizing the `circuits`_ framework for the sole purpose of logging a set of IRC
        Channels to disk in the form that something like `irclog2html`_ can understand and parse.
        
        
        Installation
        ------------
        
        From PyPi using pip:
        
        ::
            
            $ pip install irclogger
        
        from source:
        
        ::
            
            $ mkvirtualenv irclogger
            $ hg clone https://bitbucket.org/prologic/irclogger
            $ cd irclogger
            $ pip install -r requirements.txt
        
        
        Usage
        -----
        
        To display help:
        
        ::
            
            $ irclogger --help
        
            Usage: irclogger [options] <host> [<port>]
        
            Options:
              --version             show program's version number and exit
              -h, --help            show this help message and exit
              -d, --daemon          Enable daemon mode
              -c CHANNELS, --channel=CHANNELS
                                    Channel to join (multiple allowed)
              -n NICK, --nick=NICK  Nickname to use
              -o OUTPUT, --output=OUTPUT
                                    Path to store log files
              -p PIDFILE, --pidfile=PIDFILE
                                    Path to store PID file
              -v, --verbose         Enable verbose debugging mode
        
        To log a single channel:
        
        ::
            
            $ irclogger -c "#mychannel" irc.freenode.net
        
        .. note:: By default irclogger stores logs in the current working directory.
                  Use ``-o/--output`` to change the location to store log files.
        
        .. note:: Also note that the default nickname used is your current username
                  on your system. i.e: ``$USER``. To change this use the ``-n/--nick``
                  option.
        
        
        .. _circuits 3.0: https://pypi.python.org/pypi/circuits/3.0
        
        
        ChangeLog for irclogger
        =======================
        
        
        0.0.2 (*2014-10-04*)
        --------------------
        
        - Updated to use `circuits 3.0`_
        
        
        0.0.1 (*2013-03-10*)
        --------------------
        
        - Initial Release
        
Keywords: Python IRC Logger Daemon
Platform: POSIX
