Metadata-Version: 1.1
Name: django-modern-rpc
Version: 0.5.1
Summary: Simple and modern JSON-RPC and XML-RPC server implementation for Django
Home-page: https://github.com/alorence/django-modern-rpc
Author: Antoine Lorence
Author-email: antoine.lorence@gmail.com
License: UNKNOWN
Description: =================
        django-modern-rpc
        =================
        
        .. image:: https://travis-ci.org/alorence/django-modern-rpc.svg?branch=master
            :target: https://travis-ci.org/alorence/django-modern-rpc
        
        .. image:: https://coveralls.io/repos/github/alorence/django-modern-rpc/badge.svg?branch=master
            :target: https://coveralls.io/github/alorence/django-modern-rpc?branch=master
        
        .. image:: https://codecov.io/gh/alorence/django-modern-rpc/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/alorence/django-modern-rpc
          
        .. image:: https://readthedocs.org/projects/django-modern-rpc/badge/?version=latest
            :target: http://django-modern-rpc.readthedocs.io/
        
        .. image:: https://badge.fury.io/py/django-modern-rpc.svg
            :target: https://badge.fury.io/py/django-modern-rpc
        
        .. image:: https://img.shields.io/badge/demo-online-brightgreen.svg
            :target: http://modernrpc.herokuapp.com/
        
        -----------
        Description
        -----------
        
        django-modern-rpc is a free, lightweight RPC server for Django projects. The library is `available on PyPi`_.
        
        .. _`available on PyPi`: https://pypi.python.org/pypi/django-modern-rpc/
        
        - XML-RPC_ and `JSON-RPC 2.0`_ support. Please note that JSON-RPC 1.0 is not supported.
        - Python 2.7, 3.3, 3.4, 3.5 and 3.6
        - Django 1.8, 1.9, 1.10 and 1.11
        - HTTP Basic Auth support
        - Custom authentication support
        - Automatic protocol detection based on the request's ``Content-Type``
        - High-level error handling 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)
        
        .. _XML-RPC: http://xmlrpc.scripting.com/
        .. _JSON-RPC 2.0: http://www.jsonrpc.org/specification
        
        -----------
        Quick start
        -----------
        1. Install the library using pip:
        
        .. code:: bash
        
            pip install django-modern-rpc
        
        2. Add it to your Django applications, in ``settings.py``:
        
        .. code:: python
        
            INSTALLED_APPS = [
                #...
                'modernrpc',
                #...
            ]
        
        3. Declare an entry point, a view generating correct RPC responses to incoming requests:
        
        .. code:: python
        
            # 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. Decorate the methods you want to provide via RPC calls:
        
        .. code:: python
        
            # 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``:
        
        .. code:: python
        
            MODERNRPC_METHODS_MODULES = [
                'rpc_app.rpc_methods'
            ]
        
        Now, you can call the method ``add`` from a client:
        
        .. code:: python
        
            >>> 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`_.
        
        .. _`the full documentation`: http://django-modern-rpc.readthedocs.io
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.10
Classifier: Framework :: Django :: 1.9
Classifier: Framework :: Django :: 1.8
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Intended Audience :: Developers
