No project description provided
Project description
Overview
django-export-celery is a Django application that enables long processing exports using celery
and django-import-export
Dependencies
Python 3.6+
Packages
Django>=3.1
celery>=5.0.0
django-import-export>=2.2.0
django-author>=1.0.2
Installation and Configuration
Celery must be setup before starting.
Please refer to Using Celery with Django for more information.
- Install with
pip
pip install django-export-celery
- Add apps to
INSTALLED_APPS
andMIDDLEWARE
to project settings.
# settings.py
INSTALLED_APPS = (
...
'import_export',
'author',
'django_export_celery',
)
MIDDLEWARE = (
...
'author.middlewares.AuthorDefaultBackendMiddleware',
)
# Optionally, you can overwrite the default file upload location
# Defaults to 'django-export-celery-jobs/' if not set
DJANGO_EXPORT_CELERY_UPLOAD_TO = 'uploads/'
# Optionally, sending emails can be enabled in form
# Defaults to False if not set
DJANGO_EXPORT_CELERY_ENABLE_EMAIL = True
- Setup
model
andresources
# apps/models.py
from django.db import models
from import_export.resources import ModelResource
class Question(models.Model):
question_text = models.CharField(max_length=200)
pub_date = models.DateTimeField('date published')
@staticmethod
def get_export_resources():
return {
'rsc1': ('Question', QuestionResource),
}
class Choice(models.Model):
question = models.ForeignKey(Question, on_delete=models.CASCADE)
choice_text = models.CharField(max_length=200)
votes = models.IntegerField(default=0)
class QuestionResource(ModelResource):
class Meta:
model = Question
- Add
ExportCeleryMixin
to admin view inadmin.py
# apps/admin.py
from django.contrib import admin
from .models import Question, Choice
from import_export.admin import ImportExportMixin
from django_export_celery.mixins import ExportCeleryMixin
@admin.register(Question)
class QuestionAdmin(ExportCeleryMixin, admin.ModelAdmin):
list_display = (
'question_text',
'pub_date',
)
# also supports django-import-export admin mixins like so
@admin.register(Choice)
class ChoiceAdmin(ImportExportMixin, ExportCeleryMixin, admin.ModelAdmin):
list_display = (
'question',
'choice_text',
'votes',
)
How to use
- Click
EXPORT
button in upper right in model view
- Select export
Format
and clickSUBMIT
- Export jobs can be found in the
Export Jobs
app along with job status and file link
Demo App
./project/
contains the necessary files to start a sample project
To get started
cd project
pip install -r requirements.txt
python manage.py migrate
python manage.py createsuperuser
python manage.py runserver 8000
TODO: dummy data setup
TODO: Docker setup
Known Issues
A list of known issues to be patched in the future
- Does not respect ordering when exporting
- File format
ods
is not supported
Issue Tracker
If you have any bugs, suggestions, or compliants please report an issue here
References
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
Close
Hashes for django-export-celery-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0eb663f0a43d612099ed4494bd511d35eac5a61134d3a90b47f8146b7edd6467 |
|
MD5 | 85f3c0b197c2046469b2cd502d93c690 |
|
BLAKE2b-256 | 74a1470f16c92295bb541f7b90721c6e4abf1309412ea69cd9f29a9be13d523b |
Close
Hashes for django_export_celery-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 16f187306433be37d18a63fb6ac75b5535ce9bbbc0b7190c3e639a71fa10b1bb |
|
MD5 | 4a948357d756ef4037b3d58348e205e4 |
|
BLAKE2b-256 | 618e700053bb901092f9b5401c2daf4711e99afa06a6b0643f1125ef78ff423b |