README.rst

   1 ===============
   2 sid an xmpp bot
   3 ===============
   4
   5 Getting sid
   6 ------------
   7
   8 Currently unreleased, only a development version is available.
   9
  10 * http: https://kaliko.me/sid/
  11 * git: http://git.kaliko.me/?p=sid.git
  12
  13 Get the source with git::
  14
  15   git clone git://git.kaliko.me/sid.git
  16
  17
  18 Using the bot
  19 -------------
  20
  21 Here is a plain example::
  22
  23    #!/usr/bin/env python3
  24    # -*- coding: utf-8 -*-
  25
  26    import getpass
  27    from sid.sid import MUCBot
  28    from sid.ping import Ping
  29
  30    JID = 'bot@example.org'
  31    NICK = 'sid'
  32    PASS = getpass.getpass('Password for "{}": '.format(JID))
  33    ROOM = 'room@conf.example.org'
  34
  35    xmpp = MUCBot(JID, PASS, ROOM, NICK)
  36    xmpp.register_bot_plugin(Ping)
  37    # Connect to the XMPP server and start processing XMPP stanzas.
  38    try:
  39        xmpp.connect()
  40        xmpp.process()
  41    except KeyboardInterrupt:
  42        xmpp.shutdown_plugins()
  43
  44
  45 Contacting author
  46 -----------------
  47
  48 The current maintainer can be found on xmpp chat room <kaliko.me⊘conf.azylum.org>
  49 or you can contact him by email/xmpp <kaliko⊘azylum.org>.