Skip to main content

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

Project description

https://travis-ci.org/alorence/django-modern-rpc.svg?branch=master https://coveralls.io/repos/github/alorence/django-modern-rpc/badge.svg?branch=master https://readthedocs.org/projects/django-modern-rpc/badge/?version=latest

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, 1.9, 1.10 and 1.11
  • 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:

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.

Release history Release notifications

History Node

0.11.1

History Node

0.11.0

History Node

0.10.0

History Node

0.9.0

History Node

0.8.1

This version
History Node

0.8.0

History Node

0.7.1

History Node

0.7.0

History Node

0.6.0

History Node

0.5.2

History Node

0.5.1

History Node

0.5.0

History Node

0.4.2

History Node

0.4.1

History Node

0.4.0

History Node

0.3.2

History Node

0.3.1

History Node

0.3.0

History Node

0.2.3

History Node

0.2.2

History Node

0.2.1

History Node

0.2.0

History Node

0.1.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
django_modern_rpc-0.8.0-py2.py3-none-any.whl (27.6 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jul 12, 2017
django-modern-rpc-0.8.0.tar.gz (22.9 kB) Copy SHA256 hash SHA256 Source None Jul 12, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page