django-modern-rpc

Embed an XML-RPC / JSON-RPC server in your Django project!

Main features

• XML-RPC and JSON-RPC 2.0 support (JSON-RPC 1.0 is NOT supported)
• Custom authentication process
• Custom error handling
• Sync and async procedures
• Multiple servers
• Customizable XML / JSON backends with builtin support for orjson, ujson, rapidjson, lxml, etree, etc.

Requirements

The following Django / Python versions are supported, according to Django Installation FAQ

To enforce security, defusedxml will be installed as a dependency.

Quickstart

Install django-modern-rpc in your environment

pip install django-modern-rpc

Create an RpcServer instance and register your first procedure, in myapp/rpc.py

from modernrpc.server import RpcServer

server = RpcServer()

@server.register_procedure
def add(a: int, b: int) -> int:
    """Add two numbers and return the result.

    :param a: First number
    :param b: Second number
    :return: Sum of a and b
    """
    return a + b

Configure a path to allow RPC clients calling your procedures, in urls.py

from django.urls import path
from myapp.rpc import server

urlpatterns = [
    # ... other url patterns
    path('rpc/', server.view),  # Synchronous view
    # Alternatively, you can use the asynchronous view:
    # path('rpc/', server.async_view),
]

The server's view is already configured with CSRF exemption and POST-only restrictions.

Code quality

The project uses nox as a task runner to launch tests suite against all supported Python / Django combinations and generate a coverage report file. Ruff is used to lint and format the codebase, and mypy is used to perform type checking.

All these tools are automatically run in various GitHub Actions workflows, and external tools are used to perform static code analysis and collect coverage results.

SonarQube

Codacy

Coveralls