https://github.com/dealertrack/django-rest-framework-braces

Collection of utilities for working with django rest framework (DRF)
https://github.com/dealertrack/django-rest-framework-braces

django django-rest-framework

Last synced: 3 months ago
JSON representation

Collection of utilities for working with django rest framework (DRF)

• Host: GitHub
• URL: https://github.com/dealertrack/django-rest-framework-braces
• Owner: dealertrack
• License: other
• Created: 2015-07-01T12:45:48.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2022-11-02T12:48:07.000Z (about 2 years ago)
• Last Synced: 2024-07-21T11:03:17.993Z (4 months ago)
• Topics: django, django-rest-framework
• Language: Python
• Homepage:
• Size: 115 KB
• Stars: 73
• Watchers: 8
• Forks: 20
• Open Issues: 14
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE.rst

Awesome Lists containing this project

• starred-awesome - django-rest-framework-braces - Collection of utilities for working with django rest framework (DRF) (Python)

README

        
============================

Django Rest Framework Braces

============================

.. image:: https://badge.fury.io/py/django-rest-framework-braces.png

    :target: http://badge.fury.io/py/django-rest-framework-braces

.. image:: https://travis-ci.org/dealertrack/django-rest-framework-braces.svg?branch=master

    :target: https://travis-ci.org/dealertrack/django-rest-framework-braces

.. image:: https://coveralls.io/repos/dealertrack/django-rest-framework-braces/badge.svg

    :target: https://coveralls.io/r/dealertrack/django-rest-framework-braces

Collection of utilities for working with DRF. Name inspired by `django-braces `_.

* Free software: MIT license

* GitHub: https://github.com/dealertrack/django-rest-framework-braces

* Documentation: https://django-rest-framework-braces.readthedocs.io.

Installing

----------

Easiest way to install ``django-rest-framework-braces`` is by using ``pip``::

    $ pip install django-rest-framework-braces

Usage

-----

Once installed, you can use any of the supplied utilities by simply importing them.

For example::

    from drf_braces.mixins import MultipleSerializersViewMixin

    class MyViewSet(MultipleSerializersViewMixin, GenericViewSet):

        def create(self, request):

            serializer = self.get_serializer(serializer_class=MySerializer)

            ...

For full list of available utilities, please refer to the `documentation `_.

Testing

-------

To run the tests you need to install testing requirements first::

    $ make install

Then to run tests, you can use use Makefile command::

    $ make test