Skip to main content

Handles JSONRPC and XMLRPC requests easily with Django

Project description

========================
RPC4Django Documentation
========================

Setup
=====

Prerequisites
-------------

RPC4Django has been tested on Mac OS, Linux and Windows.

- Python_ 2.4 - 2.7
- Django_ 1.0+
- Docutils_ (optional)

.. _Python: http://www.python.org
.. _Django: http://www.djangoproject.com
.. _Docutils: http://docutils.sourceforge.net

Installation
------------

RPC4Django can be installed with pip_, easy_install_ or from source:

::

tar xvfz rpc4django-x.y.z.tar.gz
cd rpc4django-x.y.z
python setup.py install

.. _pip: http://pip.openplans.org/
.. _easy_install: http://peak.telecommunity.com/DevCenter/EasyInstall

Alternatively, RPC4Django can be used from your Django project without installing it.

::

tar xvfz rpc4django-x.y.z.tar.gz
cd rpc4django-x.y.z
cp -r rpc4django YOUR_DJANGO_PROJECT_DIRECTORY

Configuration
-------------

1. First, you need to add new url pattern to your root ``urls.py`` file.
You can replace ``r'^RPC2$'`` with anything you like.

::

# urls.py

urlpatterns = patterns('',
# rpc4django will need to be in your Python path
(r'^RPC2$', 'rpc4django.views.serve_rpc_request'),
)

2. Second, add RPC4Django to the list of installed applications in your
``settings.py``.

::

# settings.py

INSTALLED_APPS = (
'rpc4django',
)

3. Lastly, you need to let RPC4Django know which methods to make available.
RPC4Django recursively imports all the apps in ``INSTALLED_APPS``
and makes any methods importable via ``__init__.py`` with the
`@rpcmethod` decorator available as RPC methods. You can always write
your RPC methods in another module and simply import it in ``__init__.py``.

::

# testapp/__init__.py
from rpc4django import rpcmethod

# The doc string supports reST if docutils is installed
@rpcmethod(name='mynamespace.add', signature=['int', 'int', 'int'])
def add(a, b):
'''Adds two numbers together
>>> add(1, 2)
3
'''

return a+b

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for rpc4django, version 0.1.10
Filename, size File type Python version Upload date Hashes
Filename, size rpc4django-0.1.10.tar.gz (24.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page