dansan/django-modern-rpc

Simple XML-RPC and JSON-RPC server for modern Django

django-modern-rpc

Description

Django-modern-rpc provides a simple solution to implement a remote procedure call (RPC) server as part of your Django project. It supports all major Django and Python versions.

Project's main features are:

• Simple and pythonic API
• Python 2.7, 3.3, 3.4, 3.5 and 3.6
• Django 1.8 to 2.0
• XML-RPC and JSON-RPC 2.0 support (JSON-RPC 1.0 not supported)
• HTTP Basic Auth support
• Custom authentication support
• Automatic protocol detection based on request's Content-Type header
• High-level error management based on exceptions
• Multiple entry points, with specific methods and protocol attached
• RPC Methods documentation generated automatically, based on docstrings
• System introspection methods:
  • system.listMethods()
  • system.methodSignature()
  • system.methodHelp()
  • system.multicall() (XML-RPC only, using specification from https://mirrors.talideon.com/articles/multicall.html)

Quick start

1. Use pip to install the package in your environment:

   pip install django-modern-rpc
   

2. Add it to your Django applications, in settings.py:

   INSTALLED_APPS = [
       ...
       'modernrpc',
   ]
   

3. Declare an entry point, a view generating correct RPC responses to incoming requests:

   # In myproject/rpc_app/urls.py
   from django.conf.urls import url
   
   from modernrpc.views import RPCEntryPoint
   
   urlpatterns = [
       url(r'^rpc/', RPCEntryPoint.as_view()),
   ]
   

4. Use @rpc_method to register a global function in django-modern-rpc registry:

   # In myproject/rpc_app/rpc_methods.py
   from modernrpc.core import rpc_method
   
   @rpc_method
   def add(a, b):
       return a + b
   

5. Declare the list of python modules containing your RPC methods, in settings.py:

   MODERNRPC_METHODS_MODULES = [
       'rpc_app.rpc_methods'
   ]
   

Now, you can call the method add from a client:

>>> from xmlrpc.client import ServerProxy
>>> client = ServerProxy('http://localhost:8000/rpc/')
>>> print(client.add(2, 3))
5

For more information, please read the full documentation.