Metadata-Version: 1.0
Name: rpc4django
Version: 0.1.8
Summary: Handles JSONRPC and XMLRPC requests easily with Django
Home-page: http://www.davidfischer.name/rpc4django
Author: David Fischer
Author-email: rpc4django@davidfischer.name
License: BSD
Download-URL: http://www.davidfischer.name/rpc4django
Description: ========================
        RPC4Django Documentation
        ========================
        
        Setup
        =====
        
        Prerequisites
        -------------
        
        RPC4Django has been tested on Mac OS, Linux and Windows.
        
        - Python_ 2.4 - 2.6
        - Django_ 1.0+
        - Docutils_ (optional)
        
        .. _Python: http://www.python.org
        .. _Django: http://www.djangoproject.com
        .. _Docutils: http://docutils.sourceforge.net
        
        Installation
        ------------
        
        RPC4Django can be installed with pip_, easy_install_ or from source:
        
        ::
        
        tar xvfz rpc4django-x.y.z.tar.gz
        cd rpc4django-x.y.z
        python setup.py install
        
        .. _pip: http://pip.openplans.org/
        .. _easy_install: http://peak.telecommunity.com/DevCenter/EasyInstall
        
        Alternatively, RPC4Django can be used from your Django project without installing it.
        
        ::
        
        tar xvfz rpc4django-x.y.z.tar.gz
        cd rpc4django-x.y.z
        cp -r rpc4django YOUR_DJANGO_PROJECT_DIRECTORY
        
        Configuration
        -------------
        
        1. First, you need to add new url pattern to your root ``urls.py`` file.
        You can replace ``r'^RPC2$'`` with anything you like.
        
        ::
        
        # urls.py
        
        urlpatterns = patterns('',
        # rpc4django will need to be in your Python path
        (r'^RPC2$', 'rpc4django.views.serve_rpc_request'),
        )
        
        2. Second, add RPC4Django to the list of installed applications in your
        ``settings.py``.
        
        ::
        
        # settings.py
        
        INSTALLED_APPS = (
        'rpc4django',
        )
        
        3. Lastly, you need to let RPC4Django know which methods to make available.
        RPC4Django recursively imports all the apps in ``INSTALLED_APPS``
        and makes any methods importable via ``__init__.py`` with the
        `@rpcmethod` decorator available as RPC methods. You can always write
        your RPC methods in another module and simply import it in ``__init__.py``.
        
        ::
        
        # testapp/__init__.py
        from rpc4django import rpcmethod
        
        # The doc string supports reST if docutils is installed
        @rpcmethod(name='mynamespace.add', signature=['int', 'int', 'int'])
        def add(a, b):
        '''Adds two numbers together
        >>> add(1, 2)
        3
        '''
        
        return a+b
        
        
Platform: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
