Django-modern-rpc

Overview

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:
  • system.listMethods()
  • system.methodSignature()
  • system.methodHelp()
  • system.multicall() (XML-RPC only, using specification from https://mirrors.talideon.com/articles/multicall.html)

Table of Contents

• Quick start
  • Installation
  • Configuration
  • Create an entry point
  • Write and register your methods
  • Declare your RPC methods modules
  • That’s all !
• Basic usage
  • RPC methods registration
    • Decorate your RPC methods
    • Configure the registration
    • Access request, protocol and other info from a RPC method
  • Entry point configuration
    • Basic declaration
    • Advanced configuration
    • Class reference
  • Settings
    • Basic configuration
    • JSON Serialization and deserialization
    • XML serialization and deserialization
    • Python 2 String standardization
    • RPC entry points configuration
    • Other settings available
• Advanced configuration
  • Data types support
    • Basic types
    • List and structures
    • null and NoneType
    • Strings
    • Dates
  • Authentication
    • Basics
    • HTTP Basic Authentication support
  • Error handling
    • RPC Error codes and pre-defined exceptions
    • Customize error handling
  • Tips and tricks
    • Access the current request
• Get involved
  • Report issues, suggest enhancements
  • Submit a pull request
  • Execute the unit tests
  • Execute unit tests in all supported environments
• Changelog
  • Release 0.5.2 (2017-04-18)
  • Release 0.5.1 (2017-03-25)
  • Release 0.5.0 (2017-02-18)
  • Release 0.4.2 (2016-11-20)
  • Release 0.4.1 (2016-11-17)
  • Release 0.4.0 (2016-11-17)
  • Release 0.3.2 (2016-10-26)
  • Release 0.3.1 (2016-10-26)
  • Release 0.3.0 (2016-10-18)
  • Release 0.2.3 (2016-10-13)
  • Release 0.2.2 (2016-10-13)
  • Release 0.2.1 (2016-10-12)
  • Release 0.2.0 (2016-10-05)
  • Release 0.1.0 (2016-10-02)

Indices and tables

• Index
• Module Index
• Search Page