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 - "define" is currently broken, because google have buggered around
  20   with the results to a define: query. There are at least two output
  21   formats now, too: cf "define:zealot" and "define:VFS", for examples
  22   of each.
  23
  24 - Servus doesn't see things people emit with /me. This is a problem
  25   for the URL-tracking code, and needs fixing.
  26
  27 - Servus will only emit ASCII. It's not clear to me that this is
  28   wrong, but if we move to everyone having UTF8-capable irc clients,
  29   it would be nice to fix it such that it emits ASCII when it can and
  30   UTF8 otherwise
  31
  32 - Servus can only deal with being on a single channel at once
  33
  34 * Dependencies *
  35
  36 Servus depends on some things that aren't in standard python (or
  37 included in its source). You can install them system-wide or add the
  38 --prefix command to setup.py install (and make sure PYTHONPATH is
  39 sensible).
  40
  41 i) oauth2
  42
  43 https://github.com/simplegeo/python-oauth2
  44
  45 in debian stable as python-oauth2
  46
  47 ii) httplib2
  48
  49 http://code.google.com/p/httplib2/
  50
  51 in debian oldstable+ as python-httplib2
  52
  53 iii) simplejson
  54
  55 http://cheeseshop.python.org/pypi/simplejson
  56
  57 or in standard python2.6 and above
  58
  59 iv) python-twitter (which requires all of the above)
  60
  61 https://github.com/bear/python-twitter