Django Rest Framework HStore

Django Rest Framework tools for django-hstore.

This code was originally written for Nodeshot and then extracted into this generic python package.

Tested on Python 2.7 and 3.4, Django 1.6.x and 1.7.

Install

pip install djangorestframework-hstore

HStoreField Usage

This field is not sufficient to support django-hstore schema-mode.

from rest_framework import serializers
from myapp.models import MyModel

# rest_framework_hstore 
from rest_framework_hstore.fields import HStoreField

class MyHStoreSerializer(serializers.ModelSerializer):
    data = HStoreField()

    class Meta:
        model = MyModel

HStoreSerializer Usage

Supports django-hstore DictionaryField and schema-mode out of the box.

Prefer this to HStoreField.

from myapp.models import MyModel

# rest_framework_hstore 
from rest_framework_hstore.serializers import HStoreSerializer

class MyHStoreSerializer(HStoreSerializer):
    class Meta:
        model = MyModel

Contributing

Join the Django REST Framework HStore Mailing List and announce your intentions
Follow the PEP8 Style Guide for Python Code
Fork this repo
Write code
Write tests for your code
Ensure all tests pass
Ensure test coverage is not under 90%
Document your changes
Send pull request

BSD License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.