Changes between Initial Version and Version 1 of XmlRpcPlugin

Timestamp:

Dec 21, 2005, 4:14:55 AM (18 years ago)

Author:

Alec Thomas

Comment:

New hack XmlRpcPlugin, created by athomas

XmlRpcPlugin

@@ +1 @@
+= Trac XML-RPC Plugin =
+
+== Description ==
+
+This plugin allows Trac to export select parts of its interface via XML-RPC.
+
+It also includes some exported functions for manipulating tickets, with plans to include functions for other parts of Tracs API.
+
+'' '''Note:''' Unfortunately, due to some issues with mod_pythons !FieldStorage emultation layer, this plugin requires the patch in [trac-ticket:2509 #T2509] to be applied to your Trac installation.''''
+
+== Bugs/Feature Requests == 
+
+Existing bugs and feature requests for XmlRpcPlugin are 
+[report:9?COMPONENT=XmlRpcPlugin here].
+
+If you have any issues, create a 
+[http://trac-hacks.swapoff.org/newticket?component=XmlRpcPlugin&owner=athomas new ticket].
+
+== Download ==
+
+Download the zipped source from [download:xmlrpcplugin here].
+
+== Source ==
+
+You can check out the source for XmlRpcPlugin from Subversion at http://trac-hacks.swapoff.org/svn/xmlrpcplugin.
+
+== Example ==
+
+=== End-User Usage ===
+Obtain a list of XML-RPC exported functions available to my user:
+
+{{{
+#!python
+import xmlrpclib
+
+server = xmlrpclib.ServerProxy("http://athomas:password@localhost/trac-dev/RPC2")
+
+print server.tracrpc.api.list_xmlrpc_functions()
+}}}
+
+List all tickets that are owned by athomas:
+
+{{{
+#!python
+import xmlrpclib
+
+server = xmlrpclib.ServerProxy("http://athomas:password@localhost/trac-dev/RPC2")
+print server.tracrpc.ticket.query_tickets("owner=athomas")
+}}}
+
+=== API Usage ===
+Export a "hello world' function:
+
+{{{
+#!python
+from tracrpc.api import IXMLRPCProvider
+from trac.core import Component, implements
+
+class HelloWorld(Component):
+  implements(IXMLRPCProvider)
+
+  def hello_world(self):
+    return "Hello world"
+
+  def get_xmlrpc_functions(self):
+    yield ('WIKI_VIEW', self.hello_world)
+}}}
+
+
+== Author/Contributors ==
+
+'''Author:''' [wiki:athomas] [[BR]]
+'''Contributors:'''
+
+[[TagIt(plugin,athomas,alpha,0.9)]]