Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Another django rest framework
Python Other
Failed to load latest commit information.
adrest Bump version: 3.3.1 → 3.3.2
docs Update readme
example Change pagination
tests Fix tox
.bumpversion.cfg Bump version: 3.3.1 → 3.3.2
.gitignore Resolved conflicts
.travis.yml
Changelog Update version
DESCRIPTION Small refactoring
LICENSE Initial release
MANIFEST.in
Makefile Fix make
README.rst Setup bumpversion
requirements-tests.txt Fix tests for Django 1.7
requirements.txt Migrate to Django 1.5
setup.cfg Update version
setup.py Update test tools
tox.ini Fix tox

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.

Something went wrong with that request. Please try again.