Extend functionality of `django-import-export`
Project description
Description
django-import-export-extensions extends the functionality of django-import-export adding the following features:
Import/export resources in the background via Celery
Manage import/export jobs via Django Admin
DRF integration that allows to work with import/export jobs via API
Support drf-spectacular generated API schema
Additional fields and widgets (FileWidget, IntermediateManyToManyWidget, IntermediateManyToManyField)
Installation
To install django-import-export-extensions, run this command in your terminal:
$ pip install django-import-export-extensions
Add import_export and import_export_extensions to INSTALLED_APPS
# settings.py
INSTALLED_APPS = (
...
"import_export",
"import_export_extensions",
)
Run migrate command to create ImportJob/ExportJob models and collectstatic to let Django collect package static files to use in the admin.
$ python manage.py migrate
$ python manage.py collectstatic
Usage
Prepare resource for your model
# apps/books/resources.py
from import_export_extensions.resources import CeleryModelResource
from .. import models
class BookResource(CeleryModelResource):
class Meta:
model = models.Book
Use CeleryImportExportMixin class and set resource_class in admin model to import/export via Django Admin
# apps/books/admin.py
from django.contrib import admin
from import_export_extensions.admin import CeleryImportExportMixin
from .. import resources
@admin.register(models.Book)
class BookAdmin(CeleryImportExportMixin, admin.ModelAdmin):
resource_class = resources.BookResource
Prepare view sets to import/export via API
# apps/books/api/views.py
from .. import resources
from import_export_extensions.api import views
class BookExportViewSet(views.ExportJobViewSet):
resource_class = resources.BookResource
class BookImportViewSet(views.ImportJobViewSet):
resource_class = resources.BookResource
Don’t forget to configure Celery if you want to run import/export in background
Links:
License:
Free software: MIT license
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django_import_export_extensions-0.6.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a84ebfae868e5834fe8748c9f03d10440e57ee56af82c44fae51551c883607da |
|
MD5 | 8111019b966d5266330abbf3b683673c |
|
BLAKE2b-256 | 149974eb02c0c5e7f23851bba825021a53cbc73eba34ae1de350f519e31ea5ad |
Hashes for django_import_export_extensions-0.6.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee11eba73bc8fecea6505748fb4958b577600e8fe53aaba41db96cc82d09b242 |
|
MD5 | dd33e6a41a97244fe8e7278251704497 |
|
BLAKE2b-256 | fb123044dce982231891eca15ed6a2e235ff7d6ecdc6e2597d23023a3ba61133 |