README.txt

   1                           Servus, an IRC bot
   2
   3 This file documents (briefly) the development and usage of the Servus
   4 bot from the perspective of the bot operator. Servus.html contains the
   5 user-facing documentation.
   6
   7 * Invocation *
   8
   9 "python acrobat.py Servus-chiark" is the basic usage. For long-running
  10 instances, you probably want to run using nohup (and redirecting
  11 stdout somewhere sensible). Equally, if you want to change the owner,
  12 server, channel, nickname and the like, you can edit
  13 Servus-chiark.py or append the relevant overrides to the command line,
  14 e.g.:
  15 python acrobat.py Servus-chiark nickname=testbot channel=\#test owner=MyNick
  16
  17 * Known Issues *
  18
  19 - Servus doesn't see things people emit with /me. This is a problem
  20   for the URL-tracking code, and needs fixing.
  21
  22 - Servus will only emit ASCII. It's not clear to me that this is
  23   wrong, but if we move to everyone having UTF8-capable irc clients,
  24   it would be nice to fix it such that it emits ASCII when it can and
  25   UTF8 otherwise
  26
  27 - Servus can only deal with being on a single channel at once
  28
  29 * Dependencies *
  30
  31 Servus depends on some things that aren't in standard python (or
  32 included in its source). You can install them system-wide or add the
  33 --prefix command to setup.py install (and make sure PYTHONPATH is
  34 sensible).
  35
  36 i) oauth2
  37
  38 https://github.com/simplegeo/python-oauth2
  39
  40 in debian stable as python-oauth2
  41
  42 ii) httplib2
  43
  44 http://code.google.com/p/httplib2/
  45
  46 in debian oldstable+ as python-httplib2
  47
  48 iii) simplejson
  49
  50 http://cheeseshop.python.org/pypi/simplejson
  51
  52 or in standard python2.6 and above
  53
  54 iv) python-twitter (which requires all of the above)
  55
  56 http://code.google.com/p/python-twitter/
  57