https://github.com/fantomas42/django-xmlrpc
XML-RPC Server App for the Django framework
https://github.com/fantomas42/django-xmlrpc
Last synced: about 1 year ago
JSON representation
XML-RPC Server App for the Django framework
- Host: GitHub
- URL: https://github.com/fantomas42/django-xmlrpc
- Owner: Fantomas42
- License: other
- Created: 2010-07-31T13:14:14.000Z (almost 16 years ago)
- Default Branch: develop
- Last Pushed: 2023-06-02T07:12:58.000Z (about 3 years ago)
- Last Synced: 2025-04-19T07:59:29.823Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 43 KB
- Stars: 59
- Watchers: 3
- Forks: 23
- Open Issues: 4
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
==============
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'),