Skip to main content

Handles JSONRPC and XMLRPC requests easily with Django

Project description

Prerequisites

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

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

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.

Source Distribution

rpc4django-0.1.12.tar.gz (26.0 kB view details)

Uploaded Source

File details

Details for the file rpc4django-0.1.12.tar.gz.

File metadata

  • Download URL: rpc4django-0.1.12.tar.gz
  • Upload date:
  • Size: 26.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for rpc4django-0.1.12.tar.gz
Algorithm Hash digest
SHA256 75704ba6d82d6888dde837589cf3c190fe8d85ae3585a40453207800d238a42c
MD5 574fcff53a7588bf2079856a36ef407b
BLAKE2b-256 5d0264e4860eb2f3c1ef40e0216659fe18b24d57f4a1f916b93f5f4bc547975e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page