Powerful and easy AJAX framework for django applications.
Project description
Fast and easy AJAX libraries for django applications.
Requirements
Installation
Install django-ajax in your python environment
1- Download and install package:
$ pip install djangoajaxThrough Github:
pip install -e git://github.com/yceruto/django-ajax#egg=djangoajaxor simply with:
$ python setup.py install2- Add 'django_ajax' into the INSTALLED_APPS list.
3- Read usage section and enjoy its advantages!
Usage
@ajax Decorator
from django_ajax.decorators import ajax
@ajax
def my_view(request):
do_something()When nothing is returned as result of view then returns (JSON format):
{"status": 200, "statusText": "OK", "content ": null}Sending custom data in the response
@ajax
def my_view(request):
c = 2 + 3
return {'result': c}The result is send to the browser in the following way (JSON format)
{"status": 200, "statusText": "OK", "content": {"result": 5}}Combining with others decorators
from django.contrib.auth.decorators import login_required
from django_ajax.decorators import ajax
@ajax
@login_required
def my_view(request):
# if the request.user is anonymous then this view not proceed
return {'user_id': request.user.id}The JSON response:
{"status": 302, "statusText": "FOUND", "content": "/login"}Template response
from django.shortcuts import render
from django_ajax.decorators import ajax
@ajax
def my_view(request):
return render(request, 'home.html')The JSON response:
{"status": 200, "statusText": "OK", "content": "<html>...</html>"}Catch exceptions
@ajax
def my_view(request):
a = 23 / 0 # this line throws an exception
return aThe JSON response:
{"status": 500, "statusText": "INTERNAL SERVER ERROR", "content": "integer division or modulo by zero"}AJAXMiddleware
If you use AJAX quite frequently in your project, we suggest using the AJAXMiddleware described below.
Add django_ajax.middleware.AJAXMiddleware into the MIDDLEWARE_CLASSES list in settings.py.
All your responses will be converted to JSON if the request was made by AJAX, otherwise is return a HttpResponse.
AJAXMixin for class-based views
AJAXMixin is an object that calls the AJAX decorator.
from django.views.generic import TemplateView
from django_ajax.mixin import AJAXMixin
class SimpleView(AJAXMixin, TemplateView):
template_name = 'home.html'The JSON response:
{"status": 200, "statusText": "OK", "content": "<html>...</html>"}Enjoy!
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
File details
Details for the file djangoajax-2.4.2.tar.gz.
File metadata
- Download URL: djangoajax-2.4.2.tar.gz
- Upload date:
- Size: 18.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a2a881d5bfb89e81979b816370b5aed7774e8b1ac7cfa99961ff1a27c0c116f2 |
|
| MD5 | 69e67646c85c8964d2365c0011db3d72 |
|
| BLAKE2b-256 | 88f4fca6e309defee7f5a26298068a5f5e7e2774129aabc6a0f4d1a27f647f49 |
