Installation and configuration

Stable release

To install django-import-export-extensions, run the following command in your terminal:

Using pip:

pip install django-import-export-extensions

Using uv:

uv pip install django-import-export-extensions

Using poetry:

poetry add django-import-export-extensions

This is the preferred installation method, as it will always install the most recent stable release of django-import-export-extensions.

Next, add import_export and import_export_extensions to your INSTALLED_APPS setting:

settings.py

INSTALLED_APPS = [
    ...
    "import_export",
    "import_export_extensions",
]

Finally, run the migrate and collectstatic commands:

• migrate: Creates the ImportJob and ExportJob models.
• collectstatic: Allows Django to collect static files for use in the admin interface.

python manage.py migrate
python manage.py collectstatic

Celery

To use background import/export, you need to set up Celery. Once Celery is set up, no additional configuration is required.

Settings

You can configure the following settings in your Django settings file:

IMPORT_EXPORT_MAX_DATASET_ROWS

Defines the maximum number of rows allowed in a file for import, helping to avoid memory overflow. The default value is 100,000. If the file exceeds this limit, a ValueError exception will be raised during the import process.

MIME_TYPES_MAP

Mapping file extensions to mime types to import files. By default, it uses the mimetypes.types_map from Python\'s mimetypes module.

STATUS_UPDATE_ROW_COUNT

Defines the number of rows after import/export of which the task status is updated. This helps to increase the speed of import/export. The default value is 100. This parameter can be specified separately for each resource by adding status_update_row_count to its Meta.

DRF_EXPORT_DJANGO_FILTERS_BACKEND

Specifies filter backend class for django-filters in export action. Default: django_filters.rest_framework.DjangoFilterBackend

DRF_EXPORT_ORDERING_BACKEND

Specifies filter backend class for ordering in export action. Default: rest_framework.filters.OrderingFilter

Settings from django-import-export

Additionally, the package supports settings from the original django-import-export package. For full details on these settings, refer to the official documentation.

Note: The only setting that does not affect functionality in this package is IMPORT_EXPORT_TMP_STORAGE_CLASS, as the storage is not used in the implementation of CeleryImportAdminMixin.

Picking storage

To use different storage for import/export jobs you can use STORAGES from Django.

settings.py

STORAGES = {
    "default": {
        "BACKEND": "django.core.files.storage.filesystem.FileSystemStorage",
    },
    "staticfiles": {
        "BACKEND": "django.contrib.staticfiles.storage.StaticFilesStorage",
    },
    # Use this to specify custom storage for package
    "django_import_export_extensions": {
        "BACKEND": "django.core.files.storage.filesystem.FileSystemStorage",
    },
}