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://codecov.io/gh/alorence/django-modern-rpc/branch/master/graph/badge.svg https://readthedocs.org/projects/django-modern-rpc/badge/?version=latest https://badge.fury.io/py/django-modern-rpc.svg https://img.shields.io/badge/demo-online-brightgreen.svg

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.

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.8.0.tar.gz (22.9 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.8.0-py2.py3-none-any.whl (27.6 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

File hashes

Hashes for django-modern-rpc-0.8.0.tar.gz
Algorithm Hash digest
SHA256 d3e04ed0a77dc053069c70587fe779336bf6d037d7f69172ae9f80f405240f48
MD5 7ad950dd4fce13ccffe9966eaf3bea89
BLAKE2b-256 e88a2ae943253f1cb808383ef02bc2dd4979187db3b131b7de2f3bf71a10cf30

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_modern_rpc-0.8.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b2518a11fd548f56d7f126819acef20cf4dc7450974f97fdb135cab2085e74f1
MD5 d60783179e80063aeb9c4cc63fa580eb
BLAKE2b-256 2b9a9b0d20f38aec9ab66556da75bd00650fe298fb0f5357988b214b2eb615ad

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

This release

0.8.0 This release

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

0.3.1

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