File: README.rst

package info (click to toggle)
django-xmlrpc 0.1.8-1
  • links: PTS, VCS
  • area: main
  • in suites: buster, sid
  • size: 140 kB
  • sloc: python: 203; makefile: 3
file content (61 lines) | stat: -rw-r--r-- 1,714 bytes parent folder | download
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
==============
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 original version made by Svetlyak40wt compatible with
Django >= 1.8 and Python >= 2.5.

If you want to use **django_xmlrpc** for an older version of Django or Python,
please use an old release.

.. 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.

There are two ways to register methods that you want to handle:

In your project's settings. ::

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

In a file called ``xmlrpc.py`` in your application directory. ::

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

A registered method should look like this: ::

  from django_xmlrpc.decorators import xmlrpc_func

  @xmlrpc_func(returns='string', args=['string'])
  def test_xmlrpc(text):
      """Simply returns the args passed to it as a string"""
      return "Here's a response! %s" % str(text)

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

  from django_xmlrpc.views import handle_xmlrpc

  url(r'^xmlrpc/$', handle_xmlrpc, name='xmlrpc'),