summaryrefslogtreecommitdiff
path: root/gstudio/xmlrpc/rpc/README.rst
blob: bcf4ac0aecbb896a0b47328f408395368f02fccf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
==============
Django XML-RPC
==============

django_xmlrpc offers a means by which a Django developer can expose their views (or indeed any other function) using XML-RPC.

This is a fork of the version hosted at : https://code.launchpad.net/~aartemenko/django-xmlrpc/svetlyak40wt compatible with Django > 1.1.

.. contents::

Installation
============

You could retrieve the last sources from http://github.com/Fantomas42/django-xmlrpc and run the installation script ::

  $> python setup.py install

or use pip ::

  $> pip install -e git://github.com/Fantomas42/django-xmlrpc.git#egg=django-xmlrpc

Usage
=====

Register **django_xmlrpc** in your INSTALLED_APPS section of your project' settings.

Then register methods you want to handle like this in your project' settings. ::

  >>> XMLRPC_METHODS = (('path.to.your.method', 'Method name'),
  ...                   ('path.to.your.othermethod', 'Other Method name'),)

Finally we need to register the url of the XML-RPC server.
Insert something like this in your project's urls.py: ::

  >>> url(r'^xmlrpc/$', 'django_xmlrpc.views.handle_xmlrpc', name='xmlrpc'),