Skip to main content

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

Project description

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

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adrest-3.0.3.tar.gz (90.4 kB view details)

Uploaded Source

File details

Details for the file adrest-3.0.3.tar.gz.

File metadata

  • Download URL: adrest-3.0.3.tar.gz
  • Upload date:
  • Size: 90.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for adrest-3.0.3.tar.gz
Algorithm Hash digest
SHA256 b5d1fd6ee29738087fe45a848d0234d2783b90679268907020d6d0aa90fefc9b
MD5 e37d7ed7f075ef9c39f5c02f0675d160
BLAKE2b-256 90c457abd2a128342a13da0f35b6b5a90b17831e3d878986d31212dc78878e9a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page