Skip to content

benkonrath/django-csv-export-view

Folders and files

NameName
Last commit message
Last commit date

Latest commit

87b8209 · Nov 4, 2024
Nov 4, 2024
Nov 4, 2024
Mar 5, 2023
Jul 12, 2017
Jun 3, 2021
Jun 3, 2021
Jun 3, 2021
Nov 4, 2024
Nov 4, 2024
Feb 24, 2016
Jul 12, 2017
Jul 10, 2024
Mar 5, 2023
Jun 3, 2021
Mar 21, 2023
Nov 4, 2024
Nov 4, 2024

Repository files navigation

django-csv-export-view

A Django class-based view for CSV export.

Tests

Features

  • Easy CSV exports by setting a Django model and a fields or exclude iterable
  • Works with existing class-based view mixins for access control
  • Generates Microsoft Excel friendly CSV by default
  • Proper HTTP headers set for CSV
  • Easy to override defaults as needed
  • Easy integration into Django Admin

Installation

pip install django-csv-export-view

Examples of basic options

Specify a model and fields. Optionally override get_queryset().

from csv_export.views import CSVExportView
from .models import MyModel

class DataExportView(CSVExportView):
    model = MyModel
    fields = ("field", "related", "property")

    # When using related fields you will likely want to override get_queryset()
    # to use select_related(), prefetch_related() or generally filter the results.
    def get_queryset(self):
        return super().get_queryset().select_related("related")
        # -- OR --
        return super().get_queryset().prefetch_related("related")
        # -- OR --
        return queryset.exclude(deleted=True)
        # etc

You can also use related fields and properties.

from csv_export.views import CSVExportView
from .models import MyModel

class DataExportView(CSVExportView):
    model = MyModel
    fields = ("field", "related__field", "property")

__all__ is supported if you want all fields. Model properties are not included with __all__.

from csv_export.views import CSVExportView
from .models import MyModel

class DataExportView(CSVExportView):
    model = MyModel
    fields = "__all__"

exclude can be used instead of fields.

from csv_export.views import CSVExportView
from .models import MyModel

class DataExportView(CSVExportView):
    model = MyModel
    exclude = ("id",)

Override get_fields() for dynamic control of the fields.

from csv_export.views import CSVExportView
from .models import MyModel

class DataExportView(CSVExportView):
    model = MyModel

    def get_fields(self, queryset):
        fields = ["username", "email"]
        if self.request.user.is_superuser:
            fields.append("birth_date")
        return fields

Basic options

fields / exclude: An iterable of field names and properties. You cannot set both fields and exclude. fields can also be "__all__" to export all fields. Model properties are not included when "__all__" is used. Related field can be used with __. Override get_fields(self, queryset) for custom behaviour not supported by the default logic.

model: The model to use for the CSV export queryset. Override get_queryset() if you need a custom queryset.

Examples of advanced options

header, specify_separator and filename can be use for more customization.

from csv_export.views import CSVExportView
from .models import MyModel

class DataExportView(CSVExportView):
    model = MyModel
    fields = "__all__"
    header = False
    specify_separator = False
    filename = "data-export.csv"

Using verbose_names can be turned off.

from csv_export.views import CSVExportView
from .models import MyModel

class DataExportView(CSVExportView):
    model = MyModel
    fields = "__all__"
    verbose_names = False

Override get_filename() for dynamic control of the filename.

from django.utils import timezone
from csv_export.views import CSVExportView
from .models import MyModel

class DataExportView(CSVExportView):
    model = MyModel
    fields = "__all__"

    def get_filename(self, queryset):
        return "data-export-{!s}.csv".format(timezone.now())

Advanced options

header - boolean - Default: True
Whether to include the header in the CSV.

filename - string - Default: Dasherized version of verbose_name_plural from queryset.model.
Override get_filename(self, queryset) if a dynamic filename is required.

specify_separator - boolean - Default: True
Whether to include sep=<sepaator> as the first line of the CSV file. This is useful for generating Microsoft Excel friendly CSV.

verbose_names - boolean - Default: True
Whether to use capitalized verbose column names in the header of the CSV file. If False, field names are used instead.

CSV Writer Options

Example:

from csv_export.views import CSVExportView
from .models import MyModel

class DataExportView(CSVExportView):
    model = MyModel
    fields = "__all__"

    def get_csv_writer_fmtparams(self):
        fmtparams = super().get_csv_writer_fmtparams()
        fmtparams["delimiter"] = "|"
        return fmtparams

Override get_csv_writer_fmtparams(self) and return a dictionary of csv write format parameters. Default format parameters are: dialect="excel" and quoting=csv.QUOTE_ALL. See all available options in the Python docs:

https://docs.python.org/3.11/library/csv.html#csv.writer

Django Admin Integration

Example:

from django.contrib import admin
from csv_export.views import CSVExportView
from .models import MyModel

@admin.register(MyModel)
class DataAdmin(admin.ModelAdmin):
    actions = ("export_data_csv",)

    def export_data_csv(self, request, queryset):
        view = CSVExportView(queryset=queryset, fields="__all__")
        return view.get(request)

    export_data_csv.short_description = "Export CSV for selected Data records"

Contributions

Pull requests are happily accepted.

Alternatives

https://github.com/django-import-export/django-import-export/

https://github.com/mjumbewu/django-rest-framework-csv