Another django rest framework
Python Other
Latest commit 8b75c67 Nov 19, 2014 @klen Bump version: 3.3.1 → 3.3.2
Permalink
Failed to load latest commit information.
adrest Bump version: 3.3.1 → 3.3.2 Nov 19, 2014
docs Update readme Jun 13, 2013
example Change pagination Jun 12, 2013
tests
.bumpversion.cfg Bump version: 3.3.1 → 3.3.2 Nov 19, 2014
.gitignore Resolved conflicts Apr 10, 2013
.travis.yml Test Django 1.7 Sep 24, 2014
Changelog Update version Sep 24, 2014
DESCRIPTION Small refactoring Aug 16, 2012
LICENSE Initial release Mar 31, 2011
MANIFEST.in Update adrest Mar 22, 2013
Makefile Fix make Nov 15, 2014
README.rst Setup bumpversion Nov 15, 2014
requirements-tests.txt Fix tests for Django 1.7 Sep 24, 2014
requirements.txt
setup.cfg Update version Jun 24, 2014
setup.py Update test tools Jun 13, 2014
tox.ini Fix tox Sep 24, 2014

README.rst

logo ADREST

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

Documentation in construction.

Build Status Coverals Version Downloads License Donate

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

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.