Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/benkonrath/django-csv-export-view
Django class-based view for CSV exports
https://github.com/benkonrath/django-csv-export-view
csv csv-export django django-admin
Last synced: about 7 hours ago
JSON representation
Django class-based view for CSV exports
- Host: GitHub
- URL: https://github.com/benkonrath/django-csv-export-view
- Owner: benkonrath
- License: bsd-3-clause
- Created: 2017-07-11T12:05:11.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-11-04T15:02:18.000Z (11 days ago)
- Last Synced: 2024-11-04T15:03:59.555Z (11 days ago)
- Topics: csv, csv-export, django, django-admin
- Language: Python
- Homepage:
- Size: 94.7 KB
- Stars: 19
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# django-csv-export-view
A Django class-based view for CSV export.
[](https://github.com/benkonrath/django-csv-export-view/actions/workflows/tests.yml)
## 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()`.
```python
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.
```python
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__`.
```python
from csv_export.views import CSVExportView
from .models import MyModel
class DataExportView(CSVExportView):
model = MyModel
fields = "__all__"
```
`exclude` can be used instead of `fields`.
```python
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.
```python
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.
```python
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.
```python
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.
```python
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=` 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:
```python
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:
```python
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