jsonate 0.1.0

Django library that can make ANYTHING into json

## Installation ##

1. Install lib with pip:

`pip install jsonate`

**- OR -**

Put the "jsonate" directory somewhere in your python path

2. Add "jsonate" to your installed apps (in the settings.py file)


## Usage ##

### In templates

{% load jsonate %}

{{ anything|jsonate }}

This is especially useful for embedding data in in data attributes for
use with javascript libraries like jQuery (note jsonate-attr is identical to jsonate|escape):

<div id="user-widget" data-user="{{ user|jsonate-attr }}"></div>

<script>
...
user_data = $("#user-widget").data('user');
...
</script>

Or just use it directly in javascript...

<script>
var user_data = {{ user|jsonate }};
</script>

### In Python

from jsonate import jsonate

# querysets
json = jsonate(User.objects.all())

# values
json = jsonate(User.objects.values())

# model instances
json = jsonate(User.objects.get(email="[e-mail]"))

Jsonate turns datetimes into iso format for easy parsing in javascript

>>> print jsonate(User.objects.all()[0])
'''{
"username": "asdfasdf",
"first_name": "",
"last_name": "",
"is_active": false,
"email": "[e-mail]",
"is_superuser": false,
"is_staff": false,
"last_login": "2011-08-22T19:14:50.603531",
"id": 5,
"date_joined": "2011-08-22T19:14:50.220049"
}'''

## Fields / Exclude options

You may specify which fields should be serialized in the meta options of
your models. This affects the serialization of model instances, and querysets,
just like the Admin!

Example

class MyModel(models.Model):
normal_info = models.CharField(max_length=10)
sensitive_info = models.CharField(max_length=10)

class Meta:
jsonate_exclude = ('sensitive_info',)
# this would also work:
# jsonate_fields = ('normal_info',)

By default the User model in `django.contrib.auth.models` is monkey-patched
to exclude the password field when serializing querysets or instances

If you want to specify which fields will be serialized on a per-case basis,
use `values()` instead. like so

>>> jsonate(User.objects.values("username", "password"))
... '[{"username": "someuser", "password": "sha1$f26b2$d03a6123487fce20aabcdef0987654321abcdef0"}]'

note: this is obviously not a real password or salt :)