Skip to main content
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 is a free, lightweight RPC server for Django projects. The project is still under development, and its API is subject to modifications. Currently supported features are:

  • XML-RPC (as described on http://xmlrpc.scripting.com/) and JSON-RPC 2.0 (from http://www.jsonrpc.org/specification) support. Please note that JSON-RPC 1.0 is not supported.

  • Automatic protocol detection based on the request’s header Content-Type

  • Python 2.7, 3.3, 3.4 and 3.5

  • Django 1.8, 1.9 and 1.10

  • Usual error handled and reported to callers

  • Multi entry points, with specific methods and protocol attached

  • System introspection methods:

Features not yet implemented

  • Multi-call for JSON-RPC

  • Methods documentation generated as HTML page

  • Built-in support for request authentications

Quick start

  1. Install the library using pip:

    pip install django-modern-rpc
  2. Decorate the methods you want to make available via RPC calls:

# In myproject/rpc_app/rpc_methods.py
from modernrpc.core import rpc_method

@rpc_method()
def add(a, b):
    return a + b

and make sure these functions are imported at Django startup. A simple way to do this is to import them in your app’s module:

# In myproject/rpc_app/__init__.py
from rpc_app.rpc_methods import add
  1. Declare an entry point, a view which will generate a correct RPC response depending on the incoming request:

# In myproject/rpc_app/urls.py
from django.conf.urls import url

from modernrpc.views import RPCEntryPoint

urlpatterns = [
    url(r'^rpc/', RPCEntryPoint.as_view(), name="rpc_entry_point"),
]

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

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

To get 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.

Source Distribution

django-modern-rpc-0.3.1.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_modern_rpc-0.3.1-py2.py3-none-any.whl (17.4 kB view details)

Uploaded Python 2Python 3

File details

Details for the file django-modern-rpc-0.3.1.tar.gz.

File metadata

File hashes

Hashes for django-modern-rpc-0.3.1.tar.gz
Algorithm Hash digest
SHA256 5489fccc0f22c7df12e133eef113dbc01bb448c2e4ec64007ea78a7c2278d0cf
MD5 2d9e243be0b6508cbca890932b6b6479
BLAKE2b-256 7e7974d9c36cf379ecffe52238a3329d325b9cca7f4c76813029fd2d572fd9a7

See more details on using hashes here.

File details

Details for the file django_modern_rpc-0.3.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_modern_rpc-0.3.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7da7dcff09c178279c5d3220362600950a34416b7879cae090e36ce041445e1b
MD5 509ff8817262d183eb428bf8a86cbbc3
BLAKE2b-256 1a334917d8008f9eb6ac120413e2df31f03dace87be4a54638e9e0d9cd04d42a

See more details on using hashes here.

Release history Release notifications | RSS feed

2.1.0

2 files

2.0.0

2 files

1.1.0

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

1.0.0a4

2 files

1.0.0a3

2 files

1.0.0a2

2 files

1.0.0a1

2 files

0.12.1

2 files

0.12.0

2 files

0.11.1

2 files

0.11.0

2 files

0.10.0

2 files

0.9.0

2 files

0.8.1

2 files

0.8.0

2 files

0.7.1

2 files

0.7.0

2 files

0.6.0

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.2

2 files

This release

0.3.1 This release

2 files

0.3.0

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

3 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page