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.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

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

Uploaded Source

Built Distribution

adrest-3.3.0-py2.py3-none-any.whl (77.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for adrest-3.3.0.tar.gz
Algorithm Hash digest
SHA256 ef0c7345bc4ee62986a5905de6e79b9236ce01a3df8b5baaad5b05b70943bcf7
MD5 4dc6672606e8be5bed750b47f0c3ed43
BLAKE2b-256 df366c9653cb82a400daa44d2f7d2b6277773a47280a87b1f4a4512d932a00a3

See more details on using hashes here.

File details

Details for the file adrest-3.3.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for adrest-3.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3fabbfd4976aa5927f5d0ccc84b9acab364734738fa47b49820472e94eb3b15a
MD5 9b45ecadc9d08a5338fab2f8269985d3
BLAKE2b-256 c7b7764504cff74080335d6bcb963fec111f11c47ddeed5faf479ca58e0e1da1

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