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, IntermediateM2MWidget, M2MField)
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.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3afbeebcc0560fb7920b7f19a22a9fee72549686481b96459e4df9fe3a0c61bf |
|
MD5 | 10e3dcc16656ce854471a0dfb10e3833 |
|
BLAKE2b-256 | 10e9d6ea1b4395ee839ad50add2194ff58df0ead540c8d20ac34254e740906a7 |
Hashes for django_import_export_extensions-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1f1908dfe1c2aa89cb6fafb119f7c48a25ed6533292bc7710b820ba9c7d2168 |
|
MD5 | a91acf11ef83749cb318b1fca124df93 |
|
BLAKE2b-256 | ae207f649be3aa109572af69423fb8423a2700b162675513edc59081bdc2107d |