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

pip install rpc4django[reST]

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
    
    from rpc4django.views import serve_rpc_request
    
    urlpatterns = (
        # rpc4django will need to be in your Python path
        url(r'^RPC2$', 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.6.2.tar.gz (25.7 kB view details)

Uploaded Source

Built Distribution

rpc4django-0.6.2-py2.py3-none-any.whl (18.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: rpc4django-0.6.2.tar.gz
  • Upload date:
  • Size: 25.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for rpc4django-0.6.2.tar.gz
Algorithm Hash digest
SHA256 d3fa7bbe321212e6792f93b661541336fe3bbf52068b3563f0c44136450b6d71
MD5 4a3ca70af46fd3449bafb67ce99a54f2
BLAKE2b-256 cb84c98f6e0d5b3a6577fc8adc1aa97ea39c2e0f9bc438bfbb1caad3b5bea865

See more details on using hashes here.

File details

Details for the file rpc4django-0.6.2-py2.py3-none-any.whl.

File metadata

  • Download URL: rpc4django-0.6.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 18.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for rpc4django-0.6.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 060e490414bb0483feda91b762cbeac54ac928429ac97d97fa768bdf93192f99
MD5 18aeb6e9d52a3d0c63f32c54ef27de5f
BLAKE2b-256 fecf9188c7ae28e96da57eeb22796f34f30d1757df3e6e58e41565fe8f3db63d

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