djangorestframework-csv 1.3.0

Installation

$ pip install djangorestframework-csv

Usage

views.py

from rest_framework.views import APIView
from rest_framework.settings import api_settings
from rest_framework_csv import renderers as r

class MyView (APIView):
    renderer_classes = (r.CSVRenderer, ) + api_settings.DEFAULT_RENDERER_CLASSES
    ...

Alternatively, to set CSV as a default rendered format, add the following to the settings.py file:

REST_FRAMEWORK = {
    # specifying the renderers
    'DEFAULT_RENDERER_CLASSES': (
        'rest_framework_csv.renderers.CSVRenderer',
    ),
}

Pagination

Using the renderer with paginated data is also possible, with a little extension. A paginated CSV renderer is constructed like below, and should be used with views that paginate data:

from rest_framework_csv.renderers import CSVRenderer

class PaginatedCSVRenderer (CSVRenderer):
    results_field = 'results'

    def render(self, data, media_type=None, renderer_context=None):
        if not isinstance(data, list):
            data = data.get(self.results_field, [])
        return super(PaginatedCSVRenderer, self).render(data, media_type, renderer_context)

For more information about using renderers with Django REST Framework, see the API Guide or the Tutorial.

Running the tests

To run the tests against the current environment:

$ ./manage.py test

1.3.0

• Support for Python 3, derived from work by @samdobson

1.2.0

• Support consistent ordering of fields in rendered CSV; thanks to @robguttman

• Support specifying particular fields/headers in custom CSV renderer by overriding the headers attribute.

1.1.0

• Support simple CSV parsing; thanks to @sebastibe

1.0.1

• Add the package manifest

1.0.0

• Initial release