skip to navigation
skip to content

Not Logged In

adrest 3.2.1

Adrest - Another Django REST. Simple application for quick build REST API.

Package Documentation

Adrest is Another Django REST. Django application for simple make HTTP REST API.

Documentation in construction.

Build Status Coverals Version Downloads Donate

Requirements

  • Python (2.6, 2.7)
  • Django (1.3, 1.4, 1.5, 1.6)

Installation

ADRest should be installed using pip:

pip install adrest

Quick start

from adrest.api import Api
from adrest.views import ResourceView

api = Api('1.0.0')

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

urlpatterns = api.urls

Setup

Adrest settings (default values):

# Enable logs
ADREST_ACCESS_LOG = False

# Auto create adrest access key for User
ADREST_AUTO_CREATE_ACCESSKEY = False

# Max resources per page in list views
ADREST_LIMIT_PER_PAGE = 50

# Display django standart technical 500 page
ADREST_DEBUG = False

# Limit request number per second from same identifier, null is not limited
ADREST_THROTTLE_AT = 120
ADREST_THROTTLE_TIMEFRAME = 60

# We do not restrict access for OPTIONS request
ADREST_AUTHENTICATE_OPTIONS_REQUEST = False

Note

Add 'adrest' to INSTALLED_APPS

Use adrest

See test/examples in ADREST sources.

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.

 
File Type Py Version Uploaded on Size
adrest-3.2.1.tar.gz (md5) Source 2013-11-08 86KB
  • Downloads (All Versions):
  • 68 downloads in the last day
  • 2483 downloads in the last week
  • 13408 downloads in the last month