path: root/docs
diff options
authorNate Case <>2008-09-05 14:27:31 -0500
committerJeremy Kerr <>2008-09-08 10:36:15 +1000
commit83964878e92ce0687d47409b5832e7220e57d79f (patch)
tree62e6593ce8a48b480fd675e73757d52f73ef939e /docs
parent8df76da1f7f4f6bc9a22d2b2db233618c251eeb5 (diff)
Add XML-RPC interface and command line client
Introduce a new XML-RPC Patchwork interface inspired by the SOAP interface from the old Patchwork. The interface itself is fairly lightweight and generic, and provides read-only access to a limited subset of the Patchwork database, along with server-side search and flexible filtering capabilities. The command line client is modeled after the old one with some additional filtering options. The XML-RPC interface is disabled by default. You can enable it by setting ENABLE_XMLRPC = True in This feature uses the django-xmlrpc package available from Signed-off-by: Nate Case <> Signed-off-by: Jeremy Kerr <>
Diffstat (limited to 'docs')
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/INSTALL b/docs/INSTALL
index 1748601..cba69d5 100644
--- a/docs/INSTALL
+++ b/docs/INSTALL
@@ -62,6 +62,17 @@ in brackets):
cd ../../apps
ln -s ../lib/packages/django-registration ./registration
+ (OPTIONAL) If you want to enable the Patchwork XML-RPC interface,
+ which is required for pwclient to work, you'll need to set up the
+ django_xmlrpc package:
+ cd lib/packages/
+ wget \
+ tar -zxf django_xmlrpc-0.1.tar.gz
+ cd ../../apps
+ ln -s ../lib/packages/django_xmlrpc ./django_xmlrpc
The file contains default settings for patchwork, you'll
need to configure settings for your own setup.
@@ -86,6 +97,11 @@ in brackets):
+ If you wish to enable the XML-RPC interface, add the following to
+ your file:
Then, get patchwork to create its tables in your configured database:
cd apps/