Django Rest Framework Csv

CSV Tools for Django REST Framework
Alternatives To Django Rest Framework Csv
Project NameStarsDownloadsRepos Using ThisPackages Using ThisMost Recent CommitTotal ReleasesLatest ReleaseOpen IssuesLicenseLanguage
Python 100 Days135,076
a month ago682Python
Python - 100天从新手到大师
Django Rest Framework25,64924,5951,5082 days ago134December 15, 2021132otherPython
Web APIs for Django. 🎸
Awesome Django7,045
2 days ago2cc0-1.0HTML
A curated list of awesome things related to Django
Drf Yasg3,0922907616 days ago59October 25, 2020235otherPython
Automated generation of real Swagger/OpenAPI 2.0 schemas from Django REST Framework code.
Django Rest Swagger2,5162,031413 years ago50April 30, 2018168bsd-2-clausePython
Swagger Documentation Generator for Django REST Framework: deprecated
Django Rest Auth2,3311,1092410 months ago25April 01, 2019234mitPython
This app makes it extremely easy to build Django powered SPA's (Single Page App) or Mobile apps exposing all registration and authentication related functionality as CBV's (Class Base View) and REST (JSON)
Djoser2,28821257 days ago48October 30, 2020166mitPython
REST implementation of Django authentication system.
Drf Nested Routers1,4876212910 days ago19October 15, 202146apache-2.0Python
Nested Routers for Django Rest Framework
Cookiecutter Django Rest1,405
6 hours ago4mitPython
Build best practiced apis fast with Python3
Drf Extensions1,371323145 days ago16July 30, 202175mitPython
DRF-extensions is a collection of custom extensions for Django REST Framework
Alternatives To Django Rest Framework Csv
Select To Compare

Alternative Project Comparisons


build status

CSV Tools for Django REST Framework

Author: Mjumbe Wawatu Poe, Follow me on Twitter.


$ pip install djangorestframework-csv


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, ) + tuple(api_settings.DEFAULT_RENDERER_CLASSES)

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

    # specifying the renderers

Ordered Fields

By default, a CSVRenderer will output fields in sorted order. To specify an alternative field ordering you can override the header attribute. There are two ways to do this:

  1. Create a new renderer class and override the header attribute directly:

    class MyUserRenderer (CSVRenderer):
        header = ['first', 'last', 'email']
    def my_view(request):
        users = User.objects.filter(active=True)
        content = [{'first': user.first_name,
                    'last': user.last_name,
                   for user in users]
        return Response(content)
  2. Use the renderer_context to override the field ordering on the fly:

    class MyView (APIView):
        renderer_classes = [CSVRenderer]
        def get_renderer_context(self):
            context = super().get_renderer_context()
            context['header'] = (
                if 'fields' in self.request.GET else None)
            return context

Labeled Fields

Custom labels can be applied to the CSVRenderer using the labels dict attribute where each key corresponds to the header and the value corresponds to the custom label for that header.

1) Create a new renderer class and override the header and labels attribute directly:

class MyBazRenderer (CSVRenderer):
    header = ['']
    labels = {
        '': 'baz'


Using the renderer with paginated data is also possible with the new PaginatedCSVRenderer class and should be used with views that paginate data

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:

$ ./ test



  • Add support for byte order markers (BOM) (thanks @Yaoxin)
  • Documentation updates (thanks @rjemanuele and @coreyshirk)


  • CSVs with no data still output header labels (thanks @travisbloom)
  • Include a paginated renderer as part of the app (thanks @masterfloda)
  • Generators can be used as data sources for CSVStreamingRenderer (thanks @jrzerr)
  • Support for non UTF-8 encoding parsing (thanks @weasellin)


  • Make CSVRenderer.render return bytes, and CSVParser.parse expect a byte stream.
  • Have data-less renders print header row, if header is explicitly supplied
  • Drop Django 1.7 tests and add Django 1.10 tests
  • have CSVRenderer.tableize act as a generator when possible (i.e., when a header is explicitly specified).
  • Add docs for labels thanks to @radyz
  • Fix header rendering in CSVStreamingRenderer thanks to @radialnash
  • Improve unicode handling, thanks to @brandonrobertz


  • Add support for changing field labels in the CSVRenderer, thanks to @soby
  • Add support for setting CSVRenderer headers, labels, and writer_opts as renderer_context parameters.
  • Renamed CSVRenderer.headers to CSVRenderer.header; old spelling is still available for backwards compatibility, but may be removed in the future.


  • Support streaming CSV rendering, via @ivancrneto
  • Improved test configuration and project metadata, via @ticosax


  • Support unicode CSV parsing, and universal newlines, with thanks to @brocksamson


  • Renderer handles case where data is not a list by wrapping data in a list, via pull request from @dougvk
  • Better cross Python version support, via @paurullan and @vishen


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


  • 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.


  • Support simple CSV parsing; thanks to @sebastibe


  • Add the package manifest


  • Initial release
Popular Rest Projects
Popular Django Projects
Popular Application Programming Interfaces Categories

Get A Weekly Email With Trending Projects For These Categories
No Spam. Unsubscribe easily at any time.