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.1.tar.gz (90.0 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for adrest-3.0.1.tar.gz
Algorithm Hash digest
SHA256 c917f755a1ee9e3400ae3841840c32ba1f24ddb7b76a3c1a8dff04f5e1d565a6
MD5 ce2229e339caa178548addbb11b313f4
BLAKE2b-256 4f34987de14e94f862f37328f8c525ba9594374e1e23097e4b9af55f4dcd9dc3

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