Simple and modern RPC Server for Django
Project description
Important note: This project is under development, and is not ready for production environment. You are free to install and test it and provide feedback or make pull request if you want to add a feature, report a bug or try to resolve one of them.
Information
django-modern-rpc is a free, lightweight RPC server for Django projects. It supports JSON-RPC and XML-RPC requests under python 2.7, 3.3, 3.4, 3.5 and Django 1.8, 1.9 and 1.10.
Features
The project is in active development, so all the features are not yet implemented. The list of available features is:
XML-RPC & JSON-RPC support
Usual errors are correctly reported to user according to the standard
Multi-entry point, with specific methods and protocol attached
Supported system methods:
system.listMethods()
system.methodSignature()
Features planned to implement
System introspection methods (methodHelp(), etc.)
Multi-call
Installation
To install django-modern-rpc, simply use pip:
pip install django-modern-rpc
Quick start
Decorate the methods you want to make reachable from RPC call:
# 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 that is to import them in your app’s module:
# In myproject/rpc_app/__init__.py
from rpc_app.rpc_methods import add
Now, you have to declare an entry point. This is a standard Django view which will automatically route the request to the right handler (for JSON-RPC or XML-RPC call) and call the method on the server.
# 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 function add from a client:
try:
# Python 3
import xmlrpc.client as xmlrpc_module
except ImportError:
# Python 2
import xmlrpclib as xmlrpc_module
client = xmlrpc_module.ServerProxy('http://127.0.0.1:8000/all-rpc/')
print(client.add(2, 3))
# Returns: 5
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for django_modern_rpc-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 844a321f1e2415097b6f62d57527ad91e466fa5921e5c953dc0ee92a64948dcf |
|
MD5 | 5d927e9507a3f9b26c444d7ff3fec06a |
|
BLAKE2b-256 | 329e6f6438e003c4080bf8e0e0868d3dcdf68c87edbac360e43b4d6646d0d07d |
Hashes for django_modern_rpc-0.2.0-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8ca17c5894a81656515b4fadda992195db78bc35fe8c17062f404f83a3177938 |
|
MD5 | 5629856f3f2516b95c17b95a34aa8129 |
|
BLAKE2b-256 | 4c85e9f8bacc9ae064e681be566c7e85a55b2588d2f2450c389342c662793505 |