#!/usr/bin/env python
#
# Copyright (c) 2001 Dominic Mitchell.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#    documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#

"""Display help for meerkat.

A list of functions, their parameters and descriptions is output."""

__rcsid__ = "@(#) $Id: meerkathelp.py,v 1.1 2001/09/04 00:21:12 dom Exp $"
__version__ = "$Revision: 1.1 $"[11:-2]

import xmlrpclib

meerkat = "http://www.oreillynet.com/meerkat/xml-rpc/server.php"

def meerkatHelp():
    "Print out a list of functions, parameters and descriptions."
    svr = xmlrpclib.Server(meerkat)
    for meth in svr.system.listMethods():
        print "-" * 72
        sig = svr.system.methodSignature(meth)
        retval = sig[0]
        try:
            params = ", ".join(sig[1])
        except:
            params = ""
        print "%s %s(%s)" % (retval[0], meth, params)
        print svr.system.methodHelp(meth)
    return

if __name__ == '__main__':
    meerkatHelp()