django-modern-rpc

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 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

Use pip to install the package in your environment:
```
pip install django-modern-rpc
```
Add it to your Django applications, in settings.py:
```
INSTALLED_APPS = [
    ...
    'modernrpc',
]
```

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()),
]

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

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.11.0.tar.gz (26.5 kB view details)

Uploaded Apr 25, 2018 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

django_modern_rpc-0.11.0-py2.py3-none-any.whl (27.4 kB view details)

Uploaded Apr 25, 2018 Python 2Python 3

File details

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

File metadata

Download URL: django-modern-rpc-0.11.0.tar.gz
Upload date: Apr 25, 2018
Size: 26.5 kB
Tags: Source
Uploaded using Trusted Publishing? No

File hashes

Hashes for django-modern-rpc-0.11.0.tar.gz
Algorithm	Hash digest
SHA256	`4773fa4a3f4de0e817f72571d92af1cf3b863ddfa53c1e796faa275741ebcc6d`
MD5	`432b9c6bc9049c320b47b49e767a6270`
BLAKE2b-256	`b6b2bef9626fe159cd16daaaf24896ae57c54b40dd145279bd5df89dcd8c5ee7`

See more details on using hashes here.

File details

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

File metadata

Download URL: django_modern_rpc-0.11.0-py2.py3-none-any.whl
Upload date: Apr 25, 2018
Size: 27.4 kB
Tags: Python 2, Python 3
Uploaded using Trusted Publishing? No

File hashes

Hashes for django_modern_rpc-0.11.0-py2.py3-none-any.whl
Algorithm	Hash digest
SHA256	`1ded266ba3d5bf39e7fff1463dd3671405c511985e9a283920aef2fd0c07d3fe`
MD5	`a7e91bb584baee1a9b5f282f97c8ee2d`
BLAKE2b-256	`3845f67c4f421f9780032dd4c9829d0ab7b9365e40d5d35e2470a47429d2399d`