Skip to content

Latest commit

 

History

History
86 lines (61 loc) · 2.89 KB

README.markdown

File metadata and controls

86 lines (61 loc) · 2.89 KB
Raw

THIS IS A WORK IN PROGRESS

Simple REST frameword for Django

dRest aims to be simple to use REST framework for Django. dRest is influenced by piston.

Key Characteristics

  • Resource is the key concept, everything builds around it.
  • Automatic content negotiation (parsers / formatters).
  • Gets out of your way
    • You can use additional features but you don't need to.
    • Everything is optional and works with default values.
    • Simple to get started.
  • Flexible access control based on Django's users, groups and permissions.
    • Ability to assign CRUD operations per resource for each user (or group)
    • dRest will auto-generate necessary permissions into the DB
    • You can use Django's admin interface to assign permissions to users and groups
    • After this dRest automatically picks up request.user and performs authorization
  • Intentionally doesn't give you CRUD for free as piston does
    • We can add this option later if it's concidered useful, but:
    • This rarely works for legacy systems anyway
    • For anything bigger, it's usually a good idea to decouple model and presentation
  • Ability to define representation using Django's forms
    • Automatic validation of incoming/outgoing data
    • Automatic documentation generation

Example

myresources.py:

from drest.resource import Resource
from drest.http import Response


class MyTestResource(Resource):
    def get(self, request, *args, **kw):
        return {'jedi': 'luke'}

urls.py:

from django.conf.urls.defaults import patterns, include, url
from drest.resource import Resource
import myresources

mytestresource = myresources.MyTestResource()
urlpatterns = patterns('',
    url(r'^test', mytestresource),
)

License

(The MIT License)

Copyright (c) 2012 Janne Kuuskeri

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.