Welcome to ADRest documentation ¶

ADREST is an API framework for Django.

It supports REST and RPC paradigms.

copyright:	2013 by Kirill Klenov.
license:	BSD, see LICENSE for more details.

.

Contents

Welcome to ADRest documentation

Requirements ¶

Python 2.7
Django (1.5, 1.6, 1.7)

Installation ¶

ADRest should be installed using pip:

pip install adrest

Quick start ¶

from adrest import Api, ResourceView

api = Api('v1')

@api.register
class BookResource(ResourceView):
    class Meta:
        allowed_methods = 'get', 'post'
        model = 'app.book'

urlpatterns = api.urls

User Guide ¶

Note

Documentation in construction.

Bug tracker ¶

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/adrest/issues

Contributing ¶

Development of adrest happens at github: https://github.com/klen/adrest

Contributors ¶

klen (Kirill Klenov)

License ¶

Licensed under a GNU lesser general public license.