An open API service indexing awesome lists of open source software.

https://github.com/benzid-wael/djangorestframework-utils

Utils for Django REST Framework
https://github.com/benzid-wael/djangorestframework-utils

django django-rest-framework django-rest-framework-addon

Last synced: 2 months ago
JSON representation

Utils for Django REST Framework

Awesome Lists containing this project

README

          

djangorestframework-utils
=========================

|build-status-image| |pypi-version|

Overview
--------

Utilities for Django REST Framework

Requirements
------------

- Python (2.7, 3.3, 3.4)
- Django (1.6, 1.7, 1.8)
- Django REST Framework (3.0, 3.1)

Installation
------------

Install using ``pip``\ …

.. code:: bash

$ pip install djangorestframework-utils

Features
--------

* VerboseMetadata (which is more verbose and not ambiguous like ``SimpleMetadata``)
* modelserializer_factory

VerboseMetadata features
------------------------

* Add field's ``allow_null`` and ``default`` properties
* Include ``pattern`` property for ``RegexField``
* Include ``max_digits`` and ``decimal_places`` properties for ``DecimalField``

For further information, see the [documentation](http://benzid_wael.github.io/djangorestframework-utils/docs).

Example
-------

TODO: Write example.

Documentation & Support
-----------------------

Full documentation for the project is available at `docs`_.

You may also want to follow the `author`_ on Twitter.

.. _tox: http://tox.readthedocs.org/en/latest/
.. _author: https://twitter.com/benzid_wael

.. |build-status-image| image:: https://secure.travis-ci.org/benzid-wael/djangorestframework-utils.svg?branch=master
:target: http://travis-ci.org/benzid-wael/djangorestframework-utils?branch=master
.. |pypi-version| image:: https://img.shields.io/pypi/v/djangorestframework-utils.svg
:target: https://pypi.python.org/pypi/djangorestframework-utils

.. image:: https://d2weczhvl823v0.cloudfront.net/benzid-wael/django-rest-framework-utils/trend.png
:alt: Bitdeli badge
:target: https://bitdeli.com/free