django-export-download

django-export-download allows you to use your ListView to download it in different file formats like CSV or XLS by just adding the Mixin.

It provides a MultipleObject/ListView Mixin for Django. By passing the download GET parameter you can download the file. You can use this view to download the object list in different file fomats like CSV, XLS and more. You just have to provide a Resource class from django-import-export.

I addition it work very good in you django-tables2/django-filter environment.

Finally the package ships with a templatetag to include some download buttons in your ListView template.

Requirements

The package is tested with following versions, but it also should work with newer or older versions

• Django >= 1.11
• django-import-export >= 1.0.0
• Python >= 3.5

Quickstart

views.py:

from import_export import resources
from export_download.views import ResourceDownloadMixin
from django.views.generic import ListView


class MovieBudgetResource(resources.ModelResource):
    class Meta:
        model = Movie
        fields = ['title', 'budget']


class MovieListView(ResourceDownloadMixin, ListView):
    model = Movie
    resource_class = MovieBudget
    
urls.py:

urlpatterns = [
    path('movie/', MovieListView.as_view(), name='movie-list'),
]

By visiting http://localhost:8000/movie/?download you can download a CSV (which is the default) file with the movies and their budget.

http://localhost:8000/movie/?download&resource_format=xls will download a Excel file.

Dokumentation

Class Options

Here is a more complex example that includes several Resources and different file formats. It also is a example how to use django-export-download with django-filter and django-tables2.

import django_tables2 as table
from import_export import resources
from export_download.views import ResourceDownloadMixin
from django.views.generic import ListView
    

class MovieResource(resources.ModelResource):
    class Meta:
        model = Movie
        fields = ['title', 'budget', 'tatus', 'votes', 'release_date']
       
class OnlyMovieResource(resources.ModelResource):
    class Meta:
        model = Movie
        fields = ['title']

class MovieBudgetResource(resources.ModelResource):
    class Meta:
        model = Movie
        fields = ['title', 'budget']


class MovieListView(ResourceDownloadMixin, ListView, table.SingleTableMixin):
    model = Movie
    table_class = MovieTable
    filter_class = MovieFilter

    resource_class = [
        MovieResource,
        OnlyMovieResource,
        MovieBudgetResource
    ]
    resource_formats = ['csv', 'tsv', 'xls']

This implementation support 3 download formats with 3 different Resources. Following URLs are giving you the files:

http://localhost:8000/movie/?download&resource_class=0&resource_format=xls
http://localhost:8000/movie/?download&resource_class=0&resource_format=csv
http://localhost:8000/movie/?download&resource_class=0&resource_format=tsv
http://localhost:8000/movie/?download&resource_class=1&resource_format=xls
http://localhost:8000/movie/?download&resource_class=1&resource_format=csv
http://localhost:8000/movie/?download&resource_class=1&resource_format=tsv
http://localhost:8000/movie/?download&resource_class=2&resource_format=xls
http://localhost:8000/movie/?download&resource_class=2&resource_format=csv
http://localhost:8000/movie/?download&resource_class=2&resource_format=tsv

Note that resource_class defines the position of the Resource implementation in the list of resource_class

In this example there also is a filter_class. django-export-download automatically applies the filter to the queryset. It is not required, but works really well. Have a look at https://github.com/carltongibson/django-filter for more information.

Templatetags

django-export-download ships with a templatetag to render all links above.

You now can use the templatetag in you ListView

{% load export_download %}

{% resource_download_menu %}

Contribute

Fork and send a PR