django-celery-progressbar 0.2.1

Django Celery Progressbar

Simple progressbar for a Django application with Celery. Uses database as a temporary storage.

Installation

Installation is as simple as installing a package from PyPi and applying migrations:

$ pip install django-celery-progresbar
$ python manage.py migrate django_celery_progressbar

Usage

Typical usage on the side of Celery task would look like:

from django_celery_progressbar.bars import ProgressBar
from celery import shared_task

@shared_task
def do_something():
    bar = ProgressBar(
        task_id=do_something.request.id,
        total=10,
        step='Drying kelp...'
    )

    some_work()
    bar.update(
        progress='5',
        step='Making sushi...'
    )

    some_more_work()
    bar.progress.finalize()

To retireve current progressbar state, you can use built-in getter:

from django_celery_progressbar.bars import ProgressBar

bar = ProgressBar.get(task_id)
print(bar)

>>> 5 / 10 | Drying kelp...

# or as percent:
print(bar.as_percent)

>>> 50.0%

Keep in mind: as ProgressBar fetches DB object on creation, it is not updated dynamically.

Configuration

The following default settings can be overridden in your settings.py:

PROGRESSBAR_DEFAULT_TOTAL = 100
PROGRESSBAR_DESTROY_ON_EXIT = False
PROGRESSBAR_DYNAMIC_UPDATE = False

PROGRESSBAR_DEFAULT_TOTAL - Default value for ‘Total’ progressbar attribute PROGRESSBAR_DESTROY_ON_EXIT - Destroy model object on task completion PROGRESSBAR_DYNAMIC_UPDATE - Dynamically update progressbar DB object in runtime. You don’t need it turned on in stateless apps

License

• Free software: MIT license