Getting started =============== How to install -------------- **irclog** is wholly written in Python_, so you have to install Python on your system if it isn't installed yet. It depends on some Python libraries also, but its install resolves the dependencies automatically. You can install **irclog** through :program:`easy_install` or :program:`pip`: .. sourcecode:: bash $ pip install irclog $ # ... or: $ easy_install irclog .. _Python: http://www.python.org/ How to run the web server ------------------------- It has a built-in web server. What you have to do is just to use it. (Assume that IRC logs are stored in :file:`.irssi/log/` of your home directory.) .. sourcecode:: bash $ python -m irclog.web.server \ -p 80 \ $HOME/.irssi/log///.log .. note:: ````, ```` and ```` are placeholders. Then go http://localhost/ in your web browser. .. seealso:: Module :mod:`irclog.web.server` How to use your WSGI server --------------------------- .. note:: Ignore this if you don't understand what this is. If there's your preferred WSGI server like mod_wsgi_ or uWSGI_, you can server irclog on your WSGI server. :: import os import os.path import irclog.web path = os.path.join(os.environ["HOME"], ".irssi/log///.log") app = irclog.web.Application(path) .. seealso:: Package :mod:`irclog.web` .. _mod_wsgi: http://code.google.com/p/modwsgi/ .. _uWSGI: http://projects.unbit.it/uwsgi/