Version 24 (modified by Alec Thomas, 12 years ago) (diff)

Use WSGI branch, not the patch

Trac XML-RPC Plugin


* Please note that this is still alpha software, so the API may change *

This plugin allows Trac plugins to export select parts of their interface via XML-RPC.

It also includes some exported functions for manipulating tickets, with plans to include interfaces to other parts of Trac's API.

The browsable XML-RPC URI suffix is /xmlrpc, however most XML-RPC clients should use the authenticated URL suffix /login/xmlrpc as this is correctly authenticated by Trac.

WikiRPC API is complete, mostly thanks to mgood.

Ticket API is also complete, with the following types exported: component, version, milestone, type, status, resolution, priority and severity.

For example, for TracHacks the URIs are and (must be authenticated).


See the source for API usage.


Outstanding tasks are roadmap, timeline, user management (?), plugin management (?) probably more.


Unfortunately, due to some issues with mod_pythons FieldStorage emultation layer, this plugin requires this patch be applied to your Trac installation.

You must use the WSGI branch (or Trac >= 0.10) for this plugin to work, they are more robust with support for alternative content-types.

Once this patch has been applied, install in the same manner as any other Trac plugin:

# python bdist_egg
# cp dist/*.egg /srv/trac/env/plugins

You will also probably need to enable the plugin in your environments trac.ini:

tracrpc.* = enabled

Bugs/Feature Requests

Existing bugs and feature requests for XmlRpcPlugin are here.

If you have any issues, create a new ticket.


Download the zipped source from [download:xmlrpcplugin here].


You can check out the source for XmlRpcPlugin from Subversion at


End-User Usage

Obtain and print a list of XML-RPC exported functions available to my user:

import xmlrpclib

server = xmlrpclib.ServerProxy("http://athomas:password@localhost/trac-dev/login/xmlrpc")
for method in server.system.listMethods():
  print method
  print '\n'.join(['  ' + x for x in server.system.methodHelp(method).split('\n')])

List all tickets that are owned by athomas, using the XML-RPC multicall system to issue multiple RPC calls with one HTTP request:

import xmlrpclib

server = xmlrpclib.ServerProxy("http://athomas:password@localhost/trac-dev/login/xmlrpc")
tickets = server.ticket.query("owner=athomas")
print '\n'.join(map(str, server.system.multicall([{'methodName' : 'ticket.get', 'params' : [ticket]} for ticket in tickets])))

API Usage

See the source for details.


If the HTTP request to this URI is not XML, the XmlRpcPlugin will list all exported functions that the current user has permission to use.


Author: athomas
Contributors: mgood


Attachments (2)

Download all attachments as: .zip