Skip to main content

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

Project description

Travis-CI (Continuous integration) Codacy (Code quality) Coveralls (coverage report) Codecov (coverage report) Read The Doc Pypi package info Link to online demo

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.4+ (Python 2 users must ensure six package is installed)
  • Django 1.8+
  • 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.

Download files

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

Files for django-modern-rpc, version 0.12.1
Filename, size File type Python version Upload date Hashes
Filename, size django_modern_rpc-0.12.1-py2.py3-none-any.whl (28.6 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size django-modern-rpc-0.12.1.tar.gz (27.3 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